io.snappydata.thrift.common.snappydata.thrift Maven / Gradle / Ivy
// ----------------------------------------------------------------
// Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you
// may not use this file except in compliance with the License. You
// may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License. See accompanying
// LICENSE file.
// ----------------------------------------------------------------
// ----------------------------------------------------------------
// Changes for SnappyData data platform.
//
// Portions Copyright (c) 2017-2019 TIBCO Software Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you
// may not use this file except in compliance with the License. You
// may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License. See accompanying
// LICENSE file.
// ----------------------------------------------------------------
// ----------------------------------------------------------------
// snappydata.thrift
//
// This is a Thrift interface definition file for the SnappyData service.
// Target language libraries for C++, Java, C#, Ruby, PHP, (and more) are
// generated by running this file through the Thrift compiler with the
// appropriate flags. The Thrift compiler binary and runtime
// libraries for various languages are available
// from the Apache Project (http://thrift.apache.org)
//
// ----------------------------------------------------------------
namespace java io.snappydata.thrift
namespace cpp io.snappydata.thrift
namespace csharp SnappyData.Thrift
namespace py snappydata.thrift
namespace rb SnappyData.Thrift
namespace php snappydata.thrift
namespace perl SnappyData.Thrift
struct Decimal {
1: required byte signum
2: required i32 scale
3: required binary magnitude
}
struct BlobChunk {
1: required binary chunk
2: required bool last
// optional when sending from client to server for update,
// but required when returning from server to client or for gets
3: optional i64 lobId
4: optional i64 offset
// total length of LOB; will be set for first chunk but optional for rest
5: optional i64 totalLength
}
struct ClobChunk {
1: required string chunk
2: required bool last
// optional when sending from client to server for update,
// but required when returning from server to client or for gets
3: optional i64 lobId
4: optional i64 offset
// total length of LOB; will be set for first chunk but optional for rest
5: optional i64 totalLength
}
enum SnappyType {
BOOLEAN = 1
TINYINT = 2
SMALLINT = 3
INTEGER = 4
BIGINT = 5
FLOAT = 6
DOUBLE = 7
DECIMAL = 8
CHAR = 9
VARCHAR = 10
LONGVARCHAR = 11
DATE = 12
TIME = 13
TIMESTAMP = 14
BINARY = 15
VARBINARY = 16
LONGVARBINARY = 17
BLOB = 18
CLOB = 19
SQLXML = 20
ARRAY = 21
MAP = 22
STRUCT = 23
NULLTYPE = 24
JSON = 25
JAVA_OBJECT = 26 // custom Java serialized object
OTHER = 27 // custom UDTs which will be shipped as clobs
}
// constants for StatementAttrs.resultSetType
const byte RESULTSET_TYPE_FORWARD_ONLY = 1
const byte RESULTSET_TYPE_INSENSITIVE = 2
const byte RESULTSET_TYPE_SENSITIVE = 3
const byte RESULTSET_TYPE_UNKNOWN = 4
// defaults for connection/statement attributes
const bool DEFAULT_AUTOCOMMIT = false
const byte DEFAULT_RESULTSET_TYPE = RESULTSET_TYPE_FORWARD_ONLY
const bool DEFAULT_RESULTSET_UPDATABLE = false
const bool DEFAULT_RESULTSET_HOLD_CURSORS_OVER_COMMIT = false
// additional flags for transactions
enum TransactionAttribute {
AUTOCOMMIT = 1
READ_ONLY_CONNECTION = 2
WAITING_MODE = 3
DISABLE_BATCHING = 4
SYNC_COMMITS = 5
}
// the Xid for XA transactions
struct TransactionXid {
1: required i32 formatId
2: required binary globalId
3: required binary branchQualifier
}
enum RowIdLifetime {
// Indicates that this data source does not support the ROWID type.
ROWID_UNSUPPORTED = 1
// Indicates that the lifetime of a RowId from this data source is
// indeterminate; but not one of ROWID_VALID_TRANSACTION,
// ROWID_VALID_SESSION, or, ROWID_VALID_FOREVER.
ROWID_VALID_OTHER = 2
// Indicates that the lifetime of a RowId from this data source
// is at least the containing session.
ROWID_VALID_SESSION = 3
// Indicates that the lifetime of a RowId from this data source
// is at least the containing transaction.
ROWID_VALID_TRANSACTION = 4
// Indicates that the lifetime of a RowId from this data source
// is, effectively, unlimited.
ROWID_VALID_FOREVER = 5
}
enum ServiceFeature {
ALL_PROCEDURES_CALLABLE = 1
ALL_TABLES_SELECTABLE = 2
INTEGRITY_ENHANCEMENT = 3
NULLS_SORTED_HIGH = 4
NULLS_SORTED_LOW = 5
NULLS_SORTED_START = 6
NULLS_SORTED_END = 7
USES_LOCAL_FILES = 8
USES_LOCAL_FILE_PER_TABLE = 9
MIXEDCASE_IDENTIFIERS = 10
MIXEDCASE_QUOTED_IDENTIFIERS = 11
STORES_UPPERCASE_IDENTIFIERS = 12
STORES_LOWERCASE_IDENTIFIERS = 13
STORES_MIXEDCASE_IDENTIFIERS = 14
STORES_UPPERCASE_QUOTED_IDENTIFIERS = 15
STORES_LOWERCASE_QUOTED_IDENTIFIERS = 16
STORES_MIXEDCASE_QUOTED_IDENTIFIERS = 17
ALTER_TABLE_ADD_COLUMN = 18
ALTER_TABLE_DROP_COLUMN = 19
COLUMN_ALIASING = 20
NULL_CONCAT_NON_NULL_IS_NULL = 21
CONVERT = 22
TABLE_CORRELATION_NAMES = 23
TABLE_CORRELATION_NAMES_DIFFERENT = 24
ORDER_BY_EXPRESSIONS = 25
ORDER_BY_UNRELATED = 26
GROUP_BY = 27
GROUP_BY_UNRELATED = 28
GROUP_BY_BEYOND_SELECT = 29
LIKE_ESCAPE = 30
MULTIPLE_RESULTSETS = 31
MULTIPLE_TRANSACTIONS = 32
NON_NULLABLE_COLUMNS = 33
SQL_GRAMMAR_MINIMUM = 34
SQL_GRAMMAR_CORE = 35
SQL_GRAMMAR_EXTENDED = 36
SQL_GRAMMAR_ANSI92_ENTRY = 37
SQL_GRAMMAR_ANSI92_INTERMEDIATE = 38
SQL_GRAMMAR_ANSI92_FULL = 39
OUTER_JOINS = 40
OUTER_JOINS_FULL = 41
OUTER_JOINS_LIMITED = 42
SCHEMAS_IN_DMLS = 43
SCHEMAS_IN_PROCEDURE_CALLS = 44
SCHEMAS_IN_TABLE_DEFS = 45
SCHEMAS_IN_INDEX_DEFS = 46
SCHEMAS_IN_PRIVILEGE_DEFS = 47
AUTOCOMMIT_FAILURE_CLOSES_ALL_RESULTSETS = 48
CATALOGS_IN_DMLS = 49
CATALOGS_IN_PROCEDURE_CALLS = 50
CATALOGS_IN_TABLE_DEFS = 51
CATALOGS_IN_INDEX_DEFS = 52
CATALOGS_IN_PRIVILEGE_DEFS = 53
POSITIONED_DELETE = 54
POSITIONED_UPDATE = 55
SELECT_FOR_UPDATE = 56
STORED_PROCEDURES = 57
SUBQUERIES_IN_COMPARISONS = 58
SUBQUERIES_IN_EXISTS = 59
SUBQUERIES_IN_INS = 60
SUBQUERIES_IN_QUANTIFIEDS = 61
SUBQUERIES_CORRELATED = 62
UNION = 63
UNION_ALL = 64
OPEN_CURSORS_ACROSS_COMMIT = 65
OPEN_CURSORS_ACROSS_ROLLBACK = 66
OPEN_STATEMENTS_ACROSS_COMMIT = 67
OPEN_STATEMENTS_ACROSS_ROLLBACK = 68
MAX_ROWSIZE_INCLUDES_BLOBSIZE = 69
TRANSACTIONS = 70
TRANSACTIONS_BOTH_DMLS_AND_DDLS = 71
TRANSACTIONS_DMLS_ONLY = 72
TRANSACTIONS_DDLS_IMPLICIT_COMMIT = 73
TRANSACTIONS_DDLS_IGNORED = 74
TRANSACTIONS_SAVEPOINTS = 75
CALLABLE_NAMED_PARAMETERS = 76
CALLABLE_MULTIPLE_OPEN_RESULTSETS = 77
GENERATED_KEYS_RETRIEVAL = 78
GENERATED_KEYS_ALWAYS_RETURNED = 79
BATCH_UPDATES = 80
RESULTSET_FORWARD_ONLY = 81
RESULTSET_SCROLL_INSENSITIVE = 82
RESULTSET_SCROLL_SENSITIVE = 83
RESULTSET_HOLDABILITY_CLOSE_CURSORS_AT_COMMIT = 84
RESULTSET_HOLDABILITY_HOLD_CURSORS_OVER_COMMIT = 85
LOB_UPDATES_COPY = 86
STATEMENT_POOLING = 87
STORED_FUNCTIONS_USING_CALL = 88
}
enum ServiceFeatureParameterized {
TRANSACTIONS_SUPPORT_ISOLATION = 1
RESULTSET_TYPE = 2
RESULTSET_CONCURRENCY_READ_ONLY = 3
RESULTSET_CONCURRENCY_UPDATABLE = 4
RESULTSET_OWN_UPDATES_VISIBLE = 5
RESULTSET_OWN_DELETES_VISIBLE = 6
RESULTSET_OWN_INSERTS_VISIBLE = 7
RESULTSET_OTHERS_UPDATES_VISIBLE = 8
RESULTSET_OTHERS_DELETES_VISIBLE = 9
RESULTSET_OTHERS_INSERTS_VISIBLE = 10
RESULTSET_UPDATES_DETECTED = 11
RESULTSET_DELETES_DETECTED = 12
RESULTSET_INSERTS_DETECTED = 13
}
struct ServiceMetaData {
1: required string productName
2: required string productVersion
3: required i32 productMajorVersion
4: required i32 productMinorVersion
5: required i32 jdbcMajorVersion
6: required i32 jdbcMinorVersion
7: required string identifierQuote
8: required list sqlKeywords
9: required list numericFunctions
10: required list stringFunctions
11: required list systemFunctions
12: required list dateTimeFunctions
13: required string searchStringEscape
// none if not present
14: optional string extraNameCharacters
// map of "fromType" to "toType"s supported by CONVERT function
15: required map> supportedCONVERT
16: required string schemaTerm
17: required string procedureTerm
18: required string catalogTerm
19: required string catalogSeparator
20: required i32 maxBinaryLiteralLength
21: required i32 maxCharLiteralLength
22: required i32 maxColumnsInGroupBy
23: required i32 maxColumnsInIndex
24: required i32 maxColumnsInOrderBy
25: required i32 maxColumnsInSelect
26: required i32 maxColumnsInTable
27: required i32 maxConnections
28: required i32 maxIndexLength
29: required i32 maxRowSize
30: required i32 maxStatementLength
31: required i32 maxOpenStatements
32: required i32 maxTableNamesInSelect
33: required i32 maxColumnNameLength
34: required i32 maxCursorNameLength
35: required i32 maxSchemaNameLength
36: required i32 maxProcedureNameLength
37: required i32 maxCatalogNameLength
38: required i32 maxTableNameLength
39: required i32 maxUserNameLength
40: required i32 defaultTransactionIsolation
41: required byte defaultResultSetType
42: required bool defaultResultSetHoldabilityHoldCursorsOverCommit
// if true then the SQLSTATEs returned by SnappyException are
// X/Open (now known as Open Group) SQL CLI else they are SQL99
43: required bool sqlStateIsXOpen
44: required bool catalogAtStart
45: required map transactionDefaults
46: required RowIdLifetime rowIdLifeTime
47: required set supportedFeatures
48: required map> featuresWithParams
}
enum ServiceMetaDataCall {
CATALOGS = 1
SCHEMAS = 2
TABLES = 3
TABLETYPES = 4
COLUMNS = 5
TABLEPRIVILEGES = 6
COLUMNPRIVILEGES = 7
PRIMARYKEYS = 8
IMPORTEDKEYS = 9
EXPORTEDKEYS = 10
CROSSREFERENCE = 11
PROCEDURES = 12
FUNCTIONS = 13
PROCEDURECOLUMNS = 14
FUNCTIONCOLUMNS = 15
ATTRIBUTES = 16
TYPEINFO = 17
SUPERTYPES = 18
SUPERTABLES = 19
VERSIONCOLUMNS = 20
CLIENTINFOPROPS = 21
PSEUDOCOLUMNS = 22
}
// constants for driver type
const byte DRIVER_JDBC = 1
const byte DRIVER_ODBC = 2
struct ServiceMetaDataArgs {
1: required i64 connId
2: required byte driverType
3: required binary token
4: optional string schema
5: optional string table
6: optional list tableTypes
7: optional string columnName
8: optional string foreignSchema
9: optional string foreignTable
10: optional string procedureName
11: optional string functionName
12: optional string attributeName
13: optional string typeName
14: optional SnappyType typeId
}
// constant for the default session token size used by security mechanisms
// like PLAIN and DIFFIE_HELLMAN
const i32 DEFAULT_SESSION_TOKEN_SIZE = 16
enum SecurityMechanism {
PLAIN = 1
DIFFIE_HELLMAN = 2
}
struct OpenConnectionArgs {
1: required string clientHostName
2: required string clientID
3: required SecurityMechanism security
4: optional string userName
5: optional string password
// should be true for connections to be used for XA transactions;
// XA operations will fail unless this is set to true for the connection
6: optional bool forXA
// number of bytes to use for connection ID token
// default is DEFAULT_SESSION_TOKEN_SIZE;
// in future will be used for encryption of token etc. with
// policy like in GFE client-server to defeat MIM attacks;
// addition of the token argument allows for that expansion in future
7: optional i32 tokenSize
8: optional bool useStringForDecimal
9: optional map properties
}
struct ConnectionProperties {
1: required i64 connId
2: required string clientHostName
3: required string clientID
4: optional string userName
// token is always set in openConnection result but not in
// fetchActiveConnections (or other future APIs returning ConnectionProperties)
5: optional binary token
// default schema of the connection
6: optional string defaultSchema
}
// enumeration of the various types of network services running in the system
// that are returned by "getPreferredServer" and similar API returning
// HostAddress that can be used by client to choose appropriate servers
// as per its own matching configuration
enum ServerType {
// old DRDA servers
DRDA = 1
// Thrift LocatorService using TCompactProtocol
THRIFT_LOCATOR_CP = 2
// Thrift LocatorService using TBinaryProtocol
THRIFT_LOCATOR_BP = 3
// Thrift LocatorService using TCompactProtocol over SSL
THRIFT_LOCATOR_CP_SSL = 4
// Thrift LocatorService using TBinaryProtocol over SSL
THRIFT_LOCATOR_BP_SSL = 5
// Thrift SnappyDataService using TCompactProtocol
THRIFT_SNAPPY_CP = 6
// Thrift SnappyDataService using TBinaryProtocol
THRIFT_SNAPPY_BP = 7
// Thrift SnappyDataService using TCompactProtocol over SSL
THRIFT_SNAPPY_CP_SSL = 8
// Thrift SnappyDataService using TBinaryProtocol over SSL
THRIFT_SNAPPY_BP_SSL = 9
}
struct HostAddress {
1: required string hostName
2: required i32 port
3: optional string ipAddress
// optional since "failedServers" may not have this
4: optional ServerType serverType
// set to true if this is the currently connected host
5: optional bool isCurrent
}
// exceptions
struct SnappyExceptionData {
1: required string reason
2: required i32 errorCode
3: optional string sqlState
// partial update counts in case of an exception during batch execution
4: optional list updateCounts
}
exception SnappyException {
1: required SnappyExceptionData exceptionData
2: required string serverInfo
3: optional list nextExceptions
}
// default batch size
const i32 DEFAULT_RESULTSET_BATCHSIZE = 8192
// default LOB chunk size
const i32 DEFAULT_LOB_CHUNKSIZE = 2097152 // 2MB
// constants for transaction isolation levels
const byte TRANSACTION_NONE = 0
const byte TRANSACTION_READ_UNCOMMITTED = 1
const byte TRANSACTION_READ_COMMITTED = 2
const byte TRANSACTION_REPEATABLE_READ = 4
const byte TRANSACTION_SERIALIZABLE = 8
// special flag to indicate no change to current isolation level
const byte TRANSACTION_NO_CHANGE = 64
// constant for the default transaction isolation
const byte DEFAULT_TRANSACTION_ISOLATION = TRANSACTION_NONE
// constants for XA transactions that match the values in XAResource
const i32 XA_OK = 0
const i32 XA_RDONLY = 3
const i32 XA_TMNOFLAGS = 0
const i32 XA_TMJOIN = 0x00200000
const i32 XA_TMENDRSCAN = 0x00800000
const i32 XA_TMSTARTRSCAN = 0x01000000
const i32 TMSUSPEND = 0x02000000
const i32 XA_TMSUCCESS = 0x04000000
const i32 XA_TMRESUME = 0x08000000
const i32 XA_TMFAIL = 0x20000000
const i32 XA_TMONEPHASE = 0x40000000
struct StatementAttrs {
1: optional byte resultSetType
2: optional bool updatable
3: optional bool holdCursorsOverCommit
4: optional bool requireAutoIncCols
// requireAutoIncCols should be true for this to take affect
5: optional list autoIncColumns
// requireAutoIncCols should be true for this to take affect
6: optional list autoIncColumnNames
7: optional i32 batchSize = DEFAULT_RESULTSET_BATCHSIZE
// absence means FETCH_UNKNOWN
8: optional bool fetchReverse
9: optional i32 lobChunkSize
10: optional i32 maxRows
11: optional i32 maxFieldSize
12: optional i32 timeout
13: optional string cursorName
14: optional bool possibleDuplicate
15: optional bool poolable
16: optional bool doEscapeProcessing
17: optional map pendingTransactionAttrs
// restrict execution to given bucket IDs of a table
// (i.e. queries will scan only these bucketIds)
18: optional set bucketIds
19: optional string bucketIdsTable
// retain bucketIds for the connection till an explicit commit/rollback
20: optional bool retainBucketIds
// Deprecated: i64 catalogVersion used now
21: optional i32 metadataVersion
// snapshot TXId to be used for current statement (to apply across connections)
22: optional string snapshotTransactionId
// the last catalog meta-data version recorded by client which will throw exception
// on mismatch so that caller can refresh catalog meta-data (if being cached)
23: optional i64 catalogVersion
}
union ColumnValue {
1: bool bool_val // BOOLEAN
2: byte byte_val // TINYINT
3: i16 i16_val // SMALLINT
4: i32 i32_val // INTEGER
5: i64 i64_val // BIGINT
// using 32-bit integer for REAL instead of double to avoid
// any changes in precision; callers must encode float as 32-bit integer
// in a manner compatible with Java's Float.floatToIntBits, or like a C/C++
// union having two fields namely float & int for conversion between the two
6: i32 float_val // REAL
7: double double_val // DOUBLE/FLOAT
8: string string_val // CHAR, VARCHAR, LONGVARCHAR
9: Decimal decimal_val // DECIMAL
10: i64 date_val // DATE (seconds since epoch)
11: i64 time_val // TIME (seconds since epoch)
12: i64 timestamp_val // TIMESTAMP (nanos since epoch)
13: binary binary_val // BINARY, VARBINARY, LONGVARBINARY
14: BlobChunk blob_val // BLOB
15: ClobChunk clob_val // CLOB, JSON, SQLXML
16: list array_val // ARRAY
17: map map_val // MAP
18: list struct_val // STRUCT
19: bool null_val // NULLTYPE
20: binary java_val // JAVA_OBJECT (serialized)
}
// constants for unknown precision/scale
const i16 COLUMN_PRECISION_UNKNOWN = 0
const i16 COLUMN_SCALE_UNKNOWN = 0
// max decimal precision supported by server
const i32 DECIMAL_MAX_PRECISION = 127
struct ColumnDescriptor {
1: required SnappyType type
2: required i16 precision
3: optional i16 scale
4: optional string name
5: optional string fullTableName
// various flags
6: optional bool updatable
7: optional bool definitelyUpdatable
8: optional bool nullable
9: optional bool autoIncrement
10: optional bool parameterIn
11: optional bool parameterOut
// types of individual elements for complex types:
// a) single for ARRAY element type
// b) two for MAP with first being the key type and second the value type
// c) multiple for STRUCT one for each field in the STRUCT
12: optional list elementTypes
13: optional string udtTypeAndClassName
}
// cursor update operation type
enum CursorUpdateOperation {
UPDATE_OP = 1
INSERT_OP = 2
DELETE_OP = 3
}
struct Row {
1: required list values
}
struct OutputParameter {
1: required SnappyType type
2: optional i32 scale
3: optional string typeName
}
// If statementId returned is this value then the statement has already
// been closed.
// If cursorId for a RowSet is set this value, then it is already finished
// and no further operations are possible
const i32 INVALID_ID = 0
// values for otherResultSetBehaviour flag of getNextResultSet
const byte NEXTRS_CLOSE_ALL_RESULTS = 0
const byte NEXTRS_KEEP_CURRENT_RESULT = 1
const byte NEXTRS_CLOSE_CURRENT_RESULT = 2
// bitmasks for RowSet.flags
// if this is the last batch of rows for current result set
const byte ROWSET_LAST_BATCH = 1
// for multiple result sets with CALL PROCEDUREs
const byte ROWSET_HAS_MORE_ROWSETS = 2
// set if offset from scrollCursor operation resulted in cursor being placed
// before first row (RowSet can contain rows after that as per fetch direction)
const byte ROWSET_BEFORE_FIRST = 4
// set if offset from scrollCursor operation resulted in cursor being placed
// after last row (RowSet can contain rows before that as per fetch direction)
const byte ROWSET_AFTER_LAST = 8
struct RowSet {
1: required list rows
// bitmask flags as a combination of constants defined above
2: required byte flags
// ID associated with this RowSet
3: required i64 cursorId
// ID of the associated statement
4: required i64 statementId
// Three arguments below are used to determine the origin of this result
// so client can detect failure cases easily when iterating over results.
// Server will fill in only the connId while token and source need to be
// filled on the client itself, if required.
5: required i64 connId
6: optional binary token
7: optional HostAddress source
// the starting row number (0-based) in case of batched results
// this is set only for scrollable resultsets
8: optional i32 offset
// set in first call but not set in subsequent *scroll*() calls
9: optional list metadata
10: optional string cursorName
11: optional SnappyExceptionData warnings
// when using an updatable query, these row IDs (in current batch) are
// returned for SELECT FOR UPDATE statements or when StatementAttributes
// indicates UPDATE in case table has no primary key
// the row ID needs to be sent back to the server for cursor update/delete
// else it will fail on server for the case when table has no primary key
12: optional list rowIdsForUpdateOrDelete
}
// statement types
const byte STATEMENT_TYPE_SELECT = 0
const byte STATEMENT_TYPE_INSERT = 1
const byte STATEMENT_TYPE_UPDATE = 2
const byte STATEMENT_TYPE_DELETE = 3
const byte STATEMENT_TYPE_CALL = 4
const byte STATEMENT_TYPE_DDL = 5
struct PrepareResult {
1: required i64 statementId
2: required byte statementType
3: required list parameterMetaData
4: optional list resultSetMetaData
5: optional SnappyExceptionData warnings
}
struct UpdateResult {
// for single row updates
1: optional i32 updateCount
// for batch updates
2: optional list batchUpdateCounts
3: optional RowSet generatedKeys
// in case the execution results in new schema being set for the connection
4: optional string newDefaultSchema
5: optional SnappyExceptionData warnings
}
struct StatementResult {
// will be set to null in case there is no result set
1: optional RowSet resultSet
// update count for DMLs else -1 if not applicable or unknown
2: optional i32 updateCount
// for batch updates in prepareAndExecute
3: optional list batchUpdateCounts
4: optional map procedureOutParams
5: optional RowSet generatedKeys
// in case the execution results in new schema being set for the connection
6: optional string newDefaultSchema
7: optional SnappyExceptionData warnings
// for prepareAndExecute
8: optional PrepareResult preparedResult
}
// for bucket to server mapping
// encapsulates both the mapping for partitioned regions for each bucket
// or for replicated regions bucketId=-1 with secondaries having all owners
struct BucketOwners {
1: required i32 bucketId
2: optional string primary
3: optional list secondaries
}
// encapsulates Spark's CatalogStorageFormat
struct CatalogStorage {
1: required map properties
2: required bool compressed
3: optional string locationUri
4: optional string inputFormat
5: optional string outputFormat
6: optional string serde
}
// encapsulates Spark's CatalogDatabase
struct CatalogSchemaObject {
1: required string name
2: required string description
3: required string locationUri
4: required map properties
}
// encapsulates Spark's CatalogTable and SnappyData extensions like BucketOwners, indexColumns etc
struct CatalogTableObject {
1: required string tableName
2: optional string schemaName
3: required string tableType
4: required CatalogStorage storage
5: required string tableSchema
6: optional string provider
7: required list partitionColumns
8: required list indexColumns
9: required list primaryKeyColumns
10: optional i32 numBuckets
11: optional i32 redundancy
// SnappyData tables have bucketOwners while hive native tables have bucketColumns, sortColumns
12: required list bucketOwners
13: required list bucketColumns
14: required list sortColumns
15: required string owner
16: required i64 createTime
17: required i64 lastAccessTime
18: required map properties
19: optional i64 sizeInBytes
20: optional i64 rowCount
// statistics for each column of the table (or empty if none)
21: required list> colStats
22: required bool isBroadcastable
23: optional string viewOriginalText
24: optional string viewText
25: optional string comment
26: required list unsupportedFeatures
27: required bool tracksPartitionsInCatalog
28: required bool schemaPreservesCase
}
// encapsulates Spark's CatalogFunction
struct CatalogFunctionObject {
1: required string functionName
2: optional string schemaName
3: required string className
4: required list resources
}
// encapsulates Spark's CatalogTablePartition
struct CatalogPartitionObject {
1: required map spec
2: required CatalogStorage storage
3: required map parameters
}
struct CatalogMetadataRequest {
1: optional string schemaName
2: optional string nameOrPattern
3: optional map properties
}
// encapsulates either the results for different kinds of get operations
// or the input for update operations listed as constants with prefix CATALOG_
struct CatalogMetadataDetails {
1: optional list names
2: optional list> properties
3: optional list> newProperties
4: optional i64 catalogSchemaVersion
5: optional bool exists
6: optional list otherFlags
7: optional CatalogSchemaObject catalogSchema
8: optional CatalogTableObject catalogTable
9: optional CatalogFunctionObject catalogFunction
10: optional list catalogPartitions
}
// different types of get operations returning CatalogMetadataDetails
const i32 CATALOG_GET_SCHEMA = 1
const i32 CATALOG_SCHEMA_EXISTS = 2
const i32 CATALOG_LIST_SCHEMAS = 3
const i32 CATALOG_GET_TABLE = 4
const i32 CATALOG_TABLE_EXISTS = 5
const i32 CATALOG_LIST_TABLES = 6
const i32 CATALOG_GET_FUNCTION = 7
const i32 CATALOG_FUNCTION_EXISTS = 8
const i32 CATALOG_LIST_FUNCTIONS = 9
const i32 CATALOG_GET_PARTITION = 10
const i32 CATALOG_LIST_PARTITION_NAMES = 11
const i32 CATALOG_LIST_PARTITIONS = 12
// different types of update operations passing CatalogMetadataDetails
const i32 CATALOG_CREATE_SCHEMA = 101
const i32 CATALOG_DROP_SCHEMA = 102
const i32 CATALOG_CREATE_TABLE = 103
const i32 CATALOG_DROP_TABLE = 104
const i32 CATALOG_ALTER_TABLE = 105
const i32 CATALOG_RENAME_TABLE = 106
const i32 CATALOG_LOAD_TABLE = 107
const i32 CATALOG_CREATE_FUNCTION = 108
const i32 CATALOG_DROP_FUNCTION = 109
const i32 CATALOG_RENAME_FUNCTION = 110
const i32 CATALOG_CREATE_PARTITIONS = 111
const i32 CATALOG_DROP_PARTITIONS = 112
const i32 CATALOG_ALTER_PARTITIONS = 113
const i32 CATALOG_RENAME_PARTITIONS = 114
const i32 CATALOG_LOAD_PARTITION = 115
const i32 CATALOG_LOAD_DYNAMIC_PARTITIONS = 116
// type IDs for EntityId used by bulkClose API
const byte BULK_CLOSE_RESULTSET = 1
const byte BULK_CLOSE_LOB = 2
const byte BULK_CLOSE_STATEMENT = 3
const byte BULK_CLOSE_CONNECTION = 4
struct EntityId {
1: required i64 id
2: required byte type
3: required i64 connId
4: required binary token
}
service LocatorService {
HostAddress getPreferredServer(
// get a server from among given ServerTypes (union)
1: set serverTypes,
// get a server from among given server groups (union)
2: set serverGroups,
3: set failedServers) throws (1: SnappyException error)
list getAllServersWithPreferredServer(
// get a server from among given ServerTypes (union)
1: set serverTypes,
// get a server from among given server groups (union)
2: set serverGroups,
3: set failedServers) throws (1: SnappyException error)
}
service SnappyDataService {
// following are copied from LocatorService since some language
// generators do not implement inheritence correctly
HostAddress getPreferredServer(
// get a server from among given ServerTypes (union)
1: set serverTypes,
// get a server from among given server groups (union)
2: set serverGroups,
3: set failedServers) throws (1: SnappyException error)
list getAllServersWithPreferredServer(
// get a server from among given ServerTypes (union)
1: set serverTypes,
// get a server from among given server groups (union)
2: set serverGroups,
3: set failedServers) throws (1: SnappyException error)
// end LocatorService
ConnectionProperties openConnection(1: OpenConnectionArgs arguments)
throws (1: SnappyException error)
StatementResult execute(1: i64 connId,
2: string sql,
// optional
3: map outputParams,
// optional
4: StatementAttrs attrs,
5: binary token) throws (1: SnappyException error)
UpdateResult executeUpdate(1: i64 connId,
2: list sqls,
// optional
3: StatementAttrs attrs,
4: binary token) throws (1: SnappyException error)
RowSet executeQuery(1: i64 connId,
2: string sql,
// optional
3: StatementAttrs attrs,
4: binary token) throws (1: SnappyException error)
PrepareResult prepareStatement(1: i64 connId,
2: string sql,
// optional
3: map outputParams,
// optional
4: StatementAttrs attrs,
5: binary token) throws (1: SnappyException error)
StatementResult executePrepared(1: i64 stmtId,
2: Row params,
// optional
3: map outputParams,
// optional
4: StatementAttrs attrs,
5: binary token) throws (1: SnappyException error)
UpdateResult executePreparedUpdate(1: i64 stmtId,
2: Row params,
// optional
3: StatementAttrs attrs,
4: binary token) throws (1: SnappyException error)
RowSet executePreparedQuery(1: i64 stmtId,
2: Row params,
// optional
3: StatementAttrs attrs,
4: binary token) throws (1: SnappyException error)
UpdateResult executePreparedBatch(1: i64 stmtId,
2: list paramsBatch,
// optional
3: StatementAttrs attrs,
4: binary token) throws (1: SnappyException error)
StatementResult prepareAndExecute(1: i64 connId,
2: string sql,
3: list paramsBatch,
// optional
4: map outputParams,
// optional
5: StatementAttrs attrs,
6: binary token) throws (1: SnappyException error)
byte beginTransaction(1: i64 connId,
2: byte isolationLevel,
// optional
3: map flags,
4: binary token) throws (1: SnappyException error)
void setTransactionAttributes(1: i64 connId,
2: map flags,
3: binary token) throws (1: SnappyException error)
map getTransactionAttributes(1: i64 connId,
2: binary token) throws (1: SnappyException error)
void commitTransaction(1: i64 connId,
2: bool startNewTransaction,
// optional
3: map flags,
4: binary token) throws (1: SnappyException error)
void rollbackTransaction(1: i64 connId,
2: bool startNewTransaction,
// optional
3: map flags,
4: binary token) throws (1: SnappyException error)
RowSet getNextResultSet(1: i64 cursorId,
2: byte otherResultSetBehaviour,
3: binary token) throws (1: SnappyException error)
BlobChunk getBlobChunk(1: i64 connId,
2: i64 lobId,
3: i64 offset,
4: i32 size,
// if true then free the server-side handle to blob when last==true
5: bool freeLobAtEnd,
6: binary token) throws (1: SnappyException error)
ClobChunk getClobChunk(1: i64 connId,
2: i64 lobId,
3: i64 offset,
4: i32 size,
// if true then free the server-side handle to blob when last==true
5: bool freeLobAtEnd,
6: binary token) throws (1: SnappyException error)
i64 sendBlobChunk(1: BlobChunk chunk,
2: i64 connId,
3: binary token) throws (1: SnappyException error)
i64 sendClobChunk(1: ClobChunk chunk,
2: i64 connId,
3: binary token) throws (1: SnappyException error)
void freeLob(1: i64 connId,
2: i64 lobId,
3: binary token) throws (1: SnappyException error)
// cursor operations
RowSet scrollCursor(1: i64 cursorId,
2: i32 offset,
3: bool offsetIsAbsolute,
4: bool fetchReverse,
5: i32 fetchSize,
6: binary token) throws (1: SnappyException error)
void executeCursorUpdate(1: i64 cursorId,
2: list operations,
3: list changedRows,
4: list> changedColumnsList,
// optional
5: list changedRowIndexes,
6: binary token) throws (1: SnappyException error)
// XA transaction support
void startXATransaction(1: i64 connId,
2: TransactionXid xid,
// to disable timeout use value of maximum i32 (0x7fffffff)
3: i32 timeoutInSeconds,
4: i32 flags,
5: binary token) throws (1: SnappyException error)
i32 prepareXATransaction(1: i64 connId,
2: TransactionXid xid,
3: binary token) throws (1: SnappyException error)
void commitXATransaction(1: i64 connId,
2: TransactionXid xid,
3: bool onePhase,
4: binary token) throws (1: SnappyException error)
void rollbackXATransaction(1: i64 connId,
2: TransactionXid xid,
3: binary token) throws (1: SnappyException error)
void forgetXATransaction(1: i64 connId,
2: TransactionXid xid,
3: binary token) throws (1: SnappyException error)
void endXATransaction(1: i64 connId,
2: TransactionXid xid,
3: i32 flags,
4: binary token) throws (1: SnappyException error)
list recoverXATransaction(1: i64 connId,
2: i32 flag,
3: binary token) throws (1: SnappyException error)
// meta-data API
ServiceMetaData getServiceMetaData(1: i64 connId,
2: binary token) throws (1: SnappyException error)
RowSet getSchemaMetaData(1: ServiceMetaDataCall schemaCall,
2: ServiceMetaDataArgs metadataArgs) throws (1: SnappyException error)
RowSet getIndexInfo(1: ServiceMetaDataArgs metadataArgs,
2: bool unique,
3: bool approximate) throws (1: SnappyException error)
RowSet getUDTs(1: ServiceMetaDataArgs metadataArgs,
2: list types) throws (1: SnappyException error)
RowSet getBestRowIdentifier(1: ServiceMetaDataArgs metadataArgs,
2: i32 scope,
3: bool nullable) throws (1: SnappyException error)
// end meta-data API
list fetchActiveConnections(1: i64 connId,
2: binary token) throws (1: SnappyException error)
map fetchActiveStatements(1: i64 connId,
2: binary token) throws (1: SnappyException error)
void cancelStatement(1: i64 stmtId,
2: binary token) throws (1: SnappyException error)
void cancelCurrentStatement(1: i64 connId,
2: binary token) throws (1: SnappyException error)
void closeResultSet (1: i64 cursorId,
2: binary token) throws (1: SnappyException error)
void closeStatement (1: i64 stmtId,
2: binary token) throws (1: SnappyException error)
oneway void closeConnection (1: i64 connId,
2: bool closeSocket,
3: binary token)
oneway void bulkClose(
// IDs of entities to be closed (ResultSet, LOB, Statement or Connection)
1: list entities)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy