Enum SqlInfo

Namespace: Arrow.Flight.Protocol.Sql

Assembly: Apache.Arrow.Flight.Sql.dll

Options for CommandGetSqlInfo.

public enum SqlInfo

Fields

[OriginalName("FLIGHT_SQL_SERVER_ARROW_VERSION")] FlightSqlServerArrowVersion = 2

Retrieves a UTF-8 string with the Arrow format version of the Flight SQL Server.

[OriginalName("FLIGHT_SQL_SERVER_BULK_INGESTION")] FlightSqlServerBulkIngestion = 10

Retrieves a boolean value indicating whether the Flight SQL Server supports executing bulk ingestion.

[OriginalName("FLIGHT_SQL_SERVER_CANCEL")] FlightSqlServerCancel = 9

Retrieves a boolean value indicating whether the Flight SQL Server supports explicit query cancellation (the CancelQuery action).

[OriginalName("FLIGHT_SQL_SERVER_INGEST_TRANSACTIONS_SUPPORTED")] FlightSqlServerIngestTransactionsSupported = 11

Retrieves a boolean value indicating whether transactions are supported for bulk ingestion. If not, invoking the method commit in the context of a bulk ingestion is a noop, and the isolation level is arrow.flight.protocol.sql.SqlTransactionIsolationLevel.TRANSACTION_NONE.

Returns:

false: if bulk ingestion transactions are unsupported;
true: if bulk ingestion transactions are supported.

[OriginalName("FLIGHT_SQL_SERVER_NAME")] FlightSqlServerName = 0

Retrieves a UTF-8 string with the name of the Flight SQL Server.

[OriginalName("FLIGHT_SQL_SERVER_READ_ONLY")] FlightSqlServerReadOnly = 3

Retrieves a boolean value indicating whether the Flight SQL Server is read only.

Returns:

false: if read-write
true: if read only

[OriginalName("FLIGHT_SQL_SERVER_SQL")] FlightSqlServerSql = 4

Retrieves a boolean value indicating whether the Flight SQL Server supports executing SQL queries.

Note that the absence of this info (as opposed to a false value) does not necessarily mean that SQL is not supported, as this property was not originally defined.

[OriginalName("FLIGHT_SQL_SERVER_STATEMENT_TIMEOUT")] FlightSqlServerStatementTimeout = 100

Retrieves an int32 indicating the timeout (in milliseconds) for prepared statement handles.

If 0, there is no timeout. Servers should reset the timeout when the handle is used in a command.

[OriginalName("FLIGHT_SQL_SERVER_SUBSTRAIT")] FlightSqlServerSubstrait = 5

Retrieves a boolean value indicating whether the Flight SQL Server supports executing Substrait plans.

[OriginalName("FLIGHT_SQL_SERVER_SUBSTRAIT_MAX_VERSION")] FlightSqlServerSubstraitMaxVersion = 7

Retrieves a string value indicating the maximum supported Substrait version, or null if Substrait is not supported.

[OriginalName("FLIGHT_SQL_SERVER_SUBSTRAIT_MIN_VERSION")] FlightSqlServerSubstraitMinVersion = 6

Retrieves a string value indicating the minimum supported Substrait version, or null if Substrait is not supported.

[OriginalName("FLIGHT_SQL_SERVER_TRANSACTION")] FlightSqlServerTransaction = 8

Retrieves an int32 indicating whether the Flight SQL Server supports the BeginTransaction/EndTransaction/BeginSavepoint/EndSavepoint actions.

Even if this is not supported, the database may still support explicit "BEGIN TRANSACTION"/"COMMIT" SQL statements (see SQL_TRANSACTIONS_SUPPORTED); this property is only about whether the server implements the Flight SQL API endpoints.

The possible values are listed in SqlSupportedTransaction.

[OriginalName("FLIGHT_SQL_SERVER_TRANSACTION_TIMEOUT")] FlightSqlServerTransactionTimeout = 101

Retrieves an int32 indicating the timeout (in milliseconds) for transactions, since transactions are not tied to a connection.

If 0, there is no timeout. Servers should reset the timeout when the handle is used in a command.

[OriginalName("FLIGHT_SQL_SERVER_VERSION")] FlightSqlServerVersion = 1

Retrieves a UTF-8 string with the native version of the Flight SQL Server.

[OriginalName("SQL_ALL_TABLES_ARE_SELECTABLE")] SqlAllTablesAreSelectable = 506

Retrieves a boolean value indicating whether all tables are selectable.

Returns:

false: if not all tables are selectable or if none are;
true: if all tables are selectable.

[OriginalName("SQL_ANSI92_SUPPORTED_LEVEL")] SqlAnsi92SupportedLevel = 526

Retrieves the supported ANSI92 SQL grammar level.

Returns an int32 bitmask value representing the supported ANSI92 SQL grammar level. The returned bitmask should be parsed in order to retrieve the supported commands.

For instance:

return 0 (\b0) => [] (ANSI92 SQL grammar is unsupported);
return 1 (\b1) => [ANSI92_ENTRY_SQL];
return 2 (\b10) => [ANSI92_INTERMEDIATE_SQL];
return 3 (\b11) => [ANSI92_ENTRY_SQL, ANSI92_INTERMEDIATE_SQL];
return 4 (\b100) => [ANSI92_FULL_SQL];
return 5 (\b101) => [ANSI92_ENTRY_SQL, ANSI92_FULL_SQL];
return 6 (\b110) => [ANSI92_INTERMEDIATE_SQL, ANSI92_FULL_SQL];
return 7 (\b111) => [ANSI92_ENTRY_SQL, ANSI92_INTERMEDIATE_SQL, ANSI92_FULL_SQL]. Valid ANSI92 SQL grammar levels are described under arrow.flight.protocol.sql.SupportedAnsi92SqlGrammarLevel.

[OriginalName("SQL_BATCH_UPDATES_SUPPORTED")] SqlBatchUpdatesSupported = 572

Retrieves a boolean value indicating whether this database supports batch updates.

false: if this database does not support batch updates;
true: if this database supports batch updates.

[OriginalName("SQL_CATALOG_AT_START")] SqlCatalogAtStart = 532

Retrieves a boolean value indicating whether a catalog appears at the start of a fully qualified table name.

false: if a catalog does not appear at the start of a fully qualified table name;
true: if a catalog appears at the start of a fully qualified table name.

[OriginalName("SQL_CATALOG_TERM")] SqlCatalogTerm = 531

Retrieves a UTF-8 string with the preferred term for "catalog". If a empty string is returned its assumed that the server does NOT supports catalogs.

[OriginalName("SQL_CATALOGS_SUPPORTED_ACTIONS")] SqlCatalogsSupportedActions = 534

Retrieves the supported actions for a SQL schema.

Returns an int32 bitmask value representing the supported actions for a SQL catalog. The returned bitmask should be parsed in order to retrieve the supported actions for a SQL catalog.

For instance:

return 0 (\b0) => [] (no supported actions for SQL catalog);
return 1 (\b1) => [SQL_ELEMENT_IN_PROCEDURE_CALLS];
return 2 (\b10) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS];
return 3 (\b11) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS];
return 4 (\b100) => [SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
return 5 (\b101) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
return 6 (\b110) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
return 7 (\b111) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS]. Valid actions for a SQL catalog are described under arrow.flight.protocol.sql.SqlSupportedElementActions.

[OriginalName("SQL_CORRELATED_SUBQUERIES_SUPPORTED")] SqlCorrelatedSubqueriesSupported = 539

Retrieves a boolean value indicating whether correlated subqueries are supported.

Returns:

false: if correlated subqueries are unsupported;
true: if correlated subqueries are supported.

[OriginalName("SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMIT")] SqlDataDefinitionCausesTransactionCommit = 565

Retrieves a boolean value indicating whether a data definition statement within a transaction forces the transaction to commit.

Returns:

false: if a data definition statement within a transaction does not force the transaction to commit;
true: if a data definition statement within a transaction forces the transaction to commit.

[OriginalName("SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNORED")] SqlDataDefinitionsInTransactionsIgnored = 566

Retrieves a boolean value indicating whether a data definition statement within a transaction is ignored.

Returns:

false: if a data definition statement within a transaction is taken into account;
true: a data definition statement within a transaction is ignored.

[OriginalName("SQL_DATETIME_FUNCTIONS")] SqlDatetimeFunctions = 512

Retrieves a UTF-8 string list with values of the supported datetime functions.

[OriginalName("SQL_DB_SCHEMA_NAME_LENGTH")] SqlDbSchemaNameLength = 552

Retrieves a int64 value representing the maximum number of characters allowed in a schema name.

[OriginalName("SQL_DDL_CATALOG")] SqlDdlCatalog = 500

Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE and DROP of catalogs.

Returns:

false: if it doesn't support CREATE and DROP of catalogs.
true: if it supports CREATE and DROP of catalogs.

[OriginalName("SQL_DDL_SCHEMA")] SqlDdlSchema = 501

Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE and DROP of schemas.

Returns:

false: if it doesn't support CREATE and DROP of schemas.
true: if it supports CREATE and DROP of schemas.

[OriginalName("SQL_DDL_TABLE")] SqlDdlTable = 502

Indicates whether the Flight SQL Server supports CREATE and DROP of tables.

Returns:

false: if it doesn't support CREATE and DROP of tables.
true: if it supports CREATE and DROP of tables.

[OriginalName("SQL_DEFAULT_TRANSACTION_ISOLATION")] SqlDefaultTransactionIsolation = 562

Retrieves this database's default transaction isolation level as described in arrow.flight.protocol.sql.SqlTransactionIsolationLevel.

Returns a int32 ordinal for the SQL transaction isolation level.

[OriginalName("SQL_EXTRA_NAME_CHARACTERS")] SqlExtraNameCharacters = 514

Retrieves a UTF-8 string with all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _).

[OriginalName("SQL_IDENTIFIER_CASE")] SqlIdentifierCase = 503

Retrieves a int32 ordinal representing the case sensitivity of catalog, table, schema and table names.

The possible values are listed in arrow.flight.protocol.sql.SqlSupportedCaseSensitivity.

[OriginalName("SQL_IDENTIFIER_QUOTE_CHAR")] SqlIdentifierQuoteChar = 504

Retrieves a UTF-8 string with the supported character(s) used to surround a delimited identifier.

[OriginalName("SQL_KEYWORDS")] SqlKeywords = 508

Retrieves a UTF-8 string list with values of the supported keywords.

[OriginalName("SQL_LOCATORS_UPDATE_COPY")] SqlLocatorsUpdateCopy = 575

Retrieves a boolean value indicating whether updates made to a LOB are made on a copy or directly to the LOB.

Returns:

false: if updates made to a LOB are made directly to the LOB;
true: if updates made to a LOB are made on a copy.

[OriginalName("SQL_MAX_BINARY_LITERAL_LENGTH")] SqlMaxBinaryLiteralLength = 541

Retrieves a int64 value representing the maximum number of hex characters allowed in an inline binary literal.

[OriginalName("SQL_MAX_CATALOG_NAME_LENGTH")] SqlMaxCatalogNameLength = 554

Retrieves a int64 value representing the maximum number of characters allowed in a catalog name.

[OriginalName("SQL_MAX_CHAR_LITERAL_LENGTH")] SqlMaxCharLiteralLength = 542

Retrieves a int64 value representing the maximum number of characters allowed for a character literal.

[OriginalName("SQL_MAX_COLUMN_NAME_LENGTH")] SqlMaxColumnNameLength = 543

Retrieves a int64 value representing the maximum number of characters allowed for a column name.

[OriginalName("SQL_MAX_COLUMNS_IN_GROUP_BY")] SqlMaxColumnsInGroupBy = 544

Retrieves a int64 value representing the maximum number of columns allowed in a GROUP BY clause.

[OriginalName("SQL_MAX_COLUMNS_IN_INDEX")] SqlMaxColumnsInIndex = 545

Retrieves a int64 value representing the maximum number of columns allowed in an index.

[OriginalName("SQL_MAX_COLUMNS_IN_ORDER_BY")] SqlMaxColumnsInOrderBy = 546

Retrieves a int64 value representing the maximum number of columns allowed in an ORDER BY clause.

[OriginalName("SQL_MAX_COLUMNS_IN_SELECT")] SqlMaxColumnsInSelect = 547

Retrieves a int64 value representing the maximum number of columns allowed in a SELECT list.

[OriginalName("SQL_MAX_COLUMNS_IN_TABLE")] SqlMaxColumnsInTable = 548

Retrieves a int64 value representing the maximum number of columns allowed in a table.

[OriginalName("SQL_MAX_CONNECTIONS")] SqlMaxConnections = 549

Retrieves a int64 value representing the maximum number of concurrent connections possible.

[OriginalName("SQL_MAX_CURSOR_NAME_LENGTH")] SqlMaxCursorNameLength = 550

Retrieves a int64 value the maximum number of characters allowed in a cursor name.

[OriginalName("SQL_MAX_INDEX_LENGTH")] SqlMaxIndexLength = 551

Retrieves a int64 value representing the maximum number of bytes allowed for an index, including all of the parts of the index.

[OriginalName("SQL_MAX_PROCEDURE_NAME_LENGTH")] SqlMaxProcedureNameLength = 553

Retrieves a int64 value representing the maximum number of characters allowed in a procedure name.

[OriginalName("SQL_MAX_ROW_SIZE")] SqlMaxRowSize = 555

Retrieves a int64 value representing the maximum number of bytes allowed in a single row.

[OriginalName("SQL_MAX_ROW_SIZE_INCLUDES_BLOBS")] SqlMaxRowSizeIncludesBlobs = 556

Retrieves a boolean indicating whether the return value for the JDBC method getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY.

Returns:

false: if return value for the JDBC method getMaxRowSize does not include the SQL data types LONGVARCHAR and LONGVARBINARY;
true: if return value for the JDBC method getMaxRowSize includes the SQL data types LONGVARCHAR and LONGVARBINARY.

[OriginalName("SQL_MAX_STATEMENT_LENGTH")] SqlMaxStatementLength = 557

Retrieves a int64 value representing the maximum number of characters allowed for an SQL statement; a result of 0 (zero) means that there is no limit or the limit is not known.

[OriginalName("SQL_MAX_STATEMENTS")] SqlMaxStatements = 558

Retrieves a int64 value representing the maximum number of active statements that can be open at the same time.

[OriginalName("SQL_MAX_TABLE_NAME_LENGTH")] SqlMaxTableNameLength = 559

Retrieves a int64 value representing the maximum number of characters allowed in a table name.

[OriginalName("SQL_MAX_TABLES_IN_SELECT")] SqlMaxTablesInSelect = 560

Retrieves a int64 value representing the maximum number of tables allowed in a SELECT statement.

[OriginalName("SQL_MAX_USERNAME_LENGTH")] SqlMaxUsernameLength = 561

Retrieves a int64 value representing the maximum number of characters allowed in a user name.

[OriginalName("SQL_NAMED_PARAMETERS_SUPPORTED")] SqlNamedParametersSupported = 574

Retrieves a boolean value indicating whether named parameters are supported in callable statements.

Returns:

false: if named parameters in callable statements are unsupported;
true: if named parameters in callable statements are supported.

[OriginalName("SQL_NULL_ORDERING")] SqlNullOrdering = 507

Retrieves the null ordering.

Returns a int32 ordinal for the null ordering being used, as described in arrow.flight.protocol.sql.SqlNullOrdering.

[OriginalName("SQL_NULL_PLUS_NULL_IS_NULL")] SqlNullPlusNullIsNull = 516

Retrieves a boolean value indicating whether concatenations between null and non-null values being null are supported.

Returns:
false: if concatenations between null and non-null values being null are unsupported;
true: if concatenations between null and non-null values being null are supported.

[OriginalName("SQL_NUMERIC_FUNCTIONS")] SqlNumericFunctions = 509

Retrieves a UTF-8 string list with values of the supported numeric functions.

[OriginalName("SQL_OUTER_JOINS_SUPPORT_LEVEL")] SqlOuterJoinsSupportLevel = 528

Retrieves the support level for SQL OUTER JOINs.

Returns a int32 ordinal for the SQL ordering being used, as described in arrow.flight.protocol.sql.SqlOuterJoinsSupportLevel.

[OriginalName("SQL_PROCEDURE_TERM")] SqlProcedureTerm = 530

Retrieves a UTF-8 string with the preferred term for "procedure".

[OriginalName("SQL_QUOTED_IDENTIFIER_CASE")] SqlQuotedIdentifierCase = 505

Retrieves a int32 describing the case sensitivity of quoted identifiers.

The possible values are listed in arrow.flight.protocol.sql.SqlSupportedCaseSensitivity.

[OriginalName("SQL_SAVEPOINTS_SUPPORTED")] SqlSavepointsSupported = 573

Retrieves a boolean value indicating whether this database supports savepoints.

Returns:

false: if this database does not support savepoints;
true: if this database supports savepoints.

[OriginalName("SQL_SCHEMA_TERM")] SqlSchemaTerm = 529

Retrieves a UTF-8 string with the preferred term for "schema".

[OriginalName("SQL_SCHEMAS_SUPPORTED_ACTIONS")] SqlSchemasSupportedActions = 533

Retrieves the supported actions for a SQL schema.

Returns an int32 bitmask value representing the supported actions for a SQL schema. The returned bitmask should be parsed in order to retrieve the supported actions for a SQL schema.

For instance:

return 0 (\b0) => [] (no supported actions for SQL schema);
return 1 (\b1) => [SQL_ELEMENT_IN_PROCEDURE_CALLS];
return 2 (\b10) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS];
return 3 (\b11) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS];
return 4 (\b100) => [SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
return 5 (\b101) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
return 6 (\b110) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
return 7 (\b111) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS]. Valid actions for a SQL schema described under arrow.flight.protocol.sql.SqlSupportedElementActions.

[OriginalName("SQL_SEARCH_STRING_ESCAPE")] SqlSearchStringEscape = 513

Retrieves the UTF-8 string that can be used to escape wildcard characters. This is the string that can be used to escape '' or '%' in the catalog search parameters that are a pattern (and therefore use one of the wildcard characters). The '' character represents any single character; the '%' character represents any sequence of zero or more characters.

[OriginalName("SQL_SELECT_FOR_UPDATE_SUPPORTED")] SqlSelectForUpdateSupported = 536

Retrieves a boolean value indicating whether SELECT FOR UPDATE statements are supported.

Returns:

false: if SELECT FOR UPDATE statements are unsupported;
true: if SELECT FOR UPDATE statements are supported.

[OriginalName("SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTED")] SqlStoredFunctionsUsingCallSyntaxSupported = 576

Retrieves a boolean value indicating whether invoking user-defined or vendor functions using the stored procedure escape syntax is supported.

Returns:

false: if invoking user-defined or vendor functions using the stored procedure escape syntax is unsupported;
true: if invoking user-defined or vendor functions using the stored procedure escape syntax is supported.

[OriginalName("SQL_STORED_PROCEDURES_SUPPORTED")] SqlStoredProceduresSupported = 537

Retrieves a boolean value indicating whether stored procedure calls that use the stored procedure escape syntax are supported.

Returns:

false: if stored procedure calls that use the stored procedure escape syntax are unsupported;
true: if stored procedure calls that use the stored procedure escape syntax are supported.

[OriginalName("SQL_STRING_FUNCTIONS")] SqlStringFunctions = 510

Retrieves a UTF-8 string list with values of the supported string functions.

[OriginalName("SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLY")] SqlSupportedConcurrenciesForResultSetForwardOnly = 569

Returns an int32 bitmask value concurrency types supported for arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_FORWARD_ONLY.

For instance:

return 0 (\b0) => [] (no supported concurrency types for this result set type)
return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]
return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE] Valid result set types are described under arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency.

[OriginalName("SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVE")] SqlSupportedConcurrenciesForResultSetScrollInsensitive = 571

Returns an int32 bitmask value concurrency types supported for arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE.

For instance:

return 0 (\b0) => [] (no supported concurrency types for this result set type)
return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]
return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE] Valid result set types are described under arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency.

[OriginalName("SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVE")] SqlSupportedConcurrenciesForResultSetScrollSensitive = 570

Returns an int32 bitmask value concurrency types supported for arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE.

For instance:

return 0 (\b0) => [] (no supported concurrency types for this result set type)
return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]
return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE] Valid result set types are described under arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency.

[OriginalName("SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIED")] SqlSupportedConcurrenciesForResultSetUnspecified = 568

Returns an int32 bitmask value concurrency types supported for arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_UNSPECIFIED.

For instance:

return 0 (\b0) => [] (no supported concurrency types for this result set type)
return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]
return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE] Valid result set types are described under arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency.

[OriginalName("SQL_SUPPORTED_GRAMMAR")] SqlSupportedGrammar = 525

Retrieves the supported SQL grammar level as per the ODBC specification.

Returns an int32 bitmask value representing the supported SQL grammar level. The returned bitmask should be parsed in order to retrieve the supported grammar levels.

For instance:

return 0 (\b0) => [] (SQL grammar is unsupported);
return 1 (\b1) => [SQL_MINIMUM_GRAMMAR];
return 2 (\b10) => [SQL_CORE_GRAMMAR];
return 3 (\b11) => [SQL_MINIMUM_GRAMMAR, SQL_CORE_GRAMMAR];
return 4 (\b100) => [SQL_EXTENDED_GRAMMAR];
return 5 (\b101) => [SQL_MINIMUM_GRAMMAR, SQL_EXTENDED_GRAMMAR];
return 6 (\b110) => [SQL_CORE_GRAMMAR, SQL_EXTENDED_GRAMMAR];
return 7 (\b111) => [SQL_MINIMUM_GRAMMAR, SQL_CORE_GRAMMAR, SQL_EXTENDED_GRAMMAR]. Valid SQL grammar levels are described under arrow.flight.protocol.sql.SupportedSqlGrammar.

[OriginalName("SQL_SUPPORTED_GROUP_BY")] SqlSupportedGroupBy = 522

Retrieves the supported GROUP BY commands;

Returns an int32 bitmask value representing the supported commands. The returned bitmask should be parsed in order to retrieve the supported commands.

For instance:

return 0 (\b0) => [] (GROUP BY is unsupported);
return 1 (\b1) => [SQL_GROUP_BY_UNRELATED];
return 2 (\b10) => [SQL_GROUP_BY_BEYOND_SELECT];
return 3 (\b11) => [SQL_GROUP_BY_UNRELATED, SQL_GROUP_BY_BEYOND_SELECT]. Valid GROUP BY types are described under arrow.flight.protocol.sql.SqlSupportedGroupBy.

[OriginalName("SQL_SUPPORTED_POSITIONED_COMMANDS")] SqlSupportedPositionedCommands = 535

Retrieves the supported SQL positioned commands.

Returns an int32 bitmask value representing the supported SQL positioned commands. The returned bitmask should be parsed in order to retrieve the supported SQL positioned commands.

For instance:

return 0 (\b0) => [] (no supported SQL positioned commands);
return 1 (\b1) => [SQL_POSITIONED_DELETE];
return 2 (\b10) => [SQL_POSITIONED_UPDATE];
return 3 (\b11) => [SQL_POSITIONED_DELETE, SQL_POSITIONED_UPDATE]. Valid SQL positioned commands are described under arrow.flight.protocol.sql.SqlSupportedPositionedCommands.

[OriginalName("SQL_SUPPORTED_RESULT_SET_TYPES")] SqlSupportedResultSetTypes = 567

Retrieves an int32 bitmask value representing the supported result set types. The returned bitmask should be parsed in order to retrieve the supported result set types.

For instance:

return 0 (\b0) => [] (no supported result set types);
return 1 (\b1) => [SQL_RESULT_SET_TYPE_UNSPECIFIED];
return 2 (\b10) => [SQL_RESULT_SET_TYPE_FORWARD_ONLY];
return 3 (\b11) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_FORWARD_ONLY];
return 4 (\b100) => [SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];
return 5 (\b101) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];
return 6 (\b110) => [SQL_RESULT_SET_TYPE_FORWARD_ONLY, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];
return 7 (\b111) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_FORWARD_ONLY, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];
return 8 (\b1000) => [SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE];
... Valid result set types are described under arrow.flight.protocol.sql.SqlSupportedResultSetType.

[OriginalName("SQL_SUPPORTED_SUBQUERIES")] SqlSupportedSubqueries = 538

Retrieves the supported SQL subqueries.

Returns an int32 bitmask value representing the supported SQL subqueries. The returned bitmask should be parsed in order to retrieve the supported SQL subqueries.

For instance:

return 0 (\b0) => [] (no supported SQL subqueries);
return 1 (\b1) => [SQL_SUBQUERIES_IN_COMPARISONS];
return 2 (\b10) => [SQL_SUBQUERIES_IN_EXISTS];
return 3 (\b11) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS];
return 4 (\b100) => [SQL_SUBQUERIES_IN_INS];
return 5 (\b101) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_INS];
return 6 (\b110) => [SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_EXISTS];
return 7 (\b111) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS];
return 8 (\b1000) => [SQL_SUBQUERIES_IN_QUANTIFIEDS];
return 9 (\b1001) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
return 10 (\b1010) => [SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
return 11 (\b1011) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
return 12 (\b1100) => [SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
return 13 (\b1101) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
return 14 (\b1110) => [SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
return 15 (\b1111) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
... Valid SQL subqueries are described under arrow.flight.protocol.sql.SqlSupportedSubqueries.

[OriginalName("SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELS")] SqlSupportedTransactionsIsolationLevels = 564

Retrieves the supported transactions isolation levels.

Returns an int32 bitmask value representing the supported transactions isolation levels. The returned bitmask should be parsed in order to retrieve the supported transactions isolation levels.

For instance:

return 0 (\b0) => [] (no supported SQL transactions isolation levels);
return 1 (\b1) => [SQL_TRANSACTION_NONE];
return 2 (\b10) => [SQL_TRANSACTION_READ_UNCOMMITTED];
return 3 (\b11) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED];
return 4 (\b100) => [SQL_TRANSACTION_REPEATABLE_READ];
return 5 (\b101) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ];
return 6 (\b110) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
return 7 (\b111) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
return 8 (\b1000) => [SQL_TRANSACTION_REPEATABLE_READ];
return 9 (\b1001) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ];
return 10 (\b1010) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
return 11 (\b1011) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
return 12 (\b1100) => [SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];
return 13 (\b1101) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];
return 14 (\b1110) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];
return 15 (\b1111) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];
return 16 (\b10000) => [SQL_TRANSACTION_SERIALIZABLE];
... Valid SQL positioned commands are described under arrow.flight.protocol.sql.SqlTransactionIsolationLevel.

[OriginalName("SQL_SUPPORTED_UNIONS")] SqlSupportedUnions = 540

Retrieves the supported SQL UNIONs.

Returns an int32 bitmask value representing the supported SQL UNIONs. The returned bitmask should be parsed in order to retrieve the supported SQL UNIONs.

For instance:

return 0 (\b0) => [] (no supported SQL positioned commands);
return 1 (\b1) => [SQL_UNION];
return 2 (\b10) => [SQL_UNION_ALL];
return 3 (\b11) => [SQL_UNION, SQL_UNION_ALL]. Valid SQL positioned commands are described under arrow.flight.protocol.sql.SqlSupportedUnions.

[OriginalName("SQL_SUPPORTS_COLUMN_ALIASING")] SqlSupportsColumnAliasing = 515

Retrieves a boolean value indicating whether column aliasing is supported. If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required.

Returns:

false: if column aliasing is unsupported;
true: if column aliasing is supported.

[OriginalName("SQL_SUPPORTS_CONVERT")] SqlSupportsConvert = 517

Retrieves a map where the key is the type to convert from and the value is a list with the types to convert to, indicating the supported conversions. Each key and each item on the list value is a value to a predefined type on SqlSupportsConvert enum. The returned map will be: map<int32, list<int32>>

[OriginalName("SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES")] SqlSupportsDifferentTableCorrelationNames = 519

Retrieves a boolean value indicating whether, when table correlation names are supported, they are restricted to being different from the names of the tables.

Returns:

false: if different table correlation names are unsupported;
true: if different table correlation names are supported

[OriginalName("SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BY")] SqlSupportsExpressionsInOrderBy = 520

Retrieves a boolean value indicating whether expressions in ORDER BY lists are supported.

Returns:

false: if expressions in ORDER BY are unsupported;
true: if expressions in ORDER BY are supported;

[OriginalName("SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITY")] SqlSupportsIntegrityEnhancementFacility = 527

Retrieves a boolean value indicating whether the SQL Integrity Enhancement Facility is supported.

Returns:

false: if the SQL Integrity Enhancement Facility is supported;
true: if the SQL Integrity Enhancement Facility is supported.

[OriginalName("SQL_SUPPORTS_LIKE_ESCAPE_CLAUSE")] SqlSupportsLikeEscapeClause = 523

Retrieves a boolean value indicating whether specifying a LIKE escape clause is supported.

Returns:

false: if specifying a LIKE escape clause is unsupported;
true: if specifying a LIKE escape clause is supported.

[OriginalName("SQL_SUPPORTS_NON_NULLABLE_COLUMNS")] SqlSupportsNonNullableColumns = 524

Retrieves a boolean value indicating whether columns may be defined as non-nullable.

Returns:

false: if columns cannot be defined as non-nullable;
true: if columns may be defined as non-nullable.

[OriginalName("SQL_SUPPORTS_ORDER_BY_UNRELATED")] SqlSupportsOrderByUnrelated = 521

Retrieves a boolean value indicating whether using a column that is not in the SELECT statement in a GROUP BY clause is supported.

Returns:

false: if using a column that is not in the SELECT statement in a GROUP BY clause is unsupported;
true: if using a column that is not in the SELECT statement in a GROUP BY clause is supported.

[OriginalName("SQL_SUPPORTS_TABLE_CORRELATION_NAMES")] SqlSupportsTableCorrelationNames = 518

Retrieves a boolean value indicating whether, when table correlation names are supported, they are restricted to being different from the names of the tables.

Returns:

false: if table correlation names are unsupported;
true: if table correlation names are supported.

[OriginalName("SQL_SYSTEM_FUNCTIONS")] SqlSystemFunctions = 511

Retrieves a UTF-8 string list with values of the supported system functions.

[OriginalName("SQL_TRANSACTIONS_SUPPORTED")] SqlTransactionsSupported = 563

Retrieves a boolean value indicating whether transactions are supported. If not, invoking the method commit is a noop, and the isolation level is arrow.flight.protocol.sql.SqlTransactionIsolationLevel.TRANSACTION_NONE.

Returns:

false: if transactions are unsupported;
true: if transactions are supported.

Table of Contents

Enum SqlInfo

Fields