public class SqlInfoBuilder extends Object
FlightSqlProducer.getStreamSqlInfo(org.apache.arrow.flight.sql.impl.FlightSql.CommandGetSqlInfo, org.apache.arrow.flight.FlightProducer.CallContext, org.apache.arrow.flight.FlightProducer.ServerStreamListener)
.
Usage requires the user to add the required SqlInfo values using the with*
methods
like withFlightSqlServerName(String)
, and request it back
through the SqlInfoBuilder#send(List, ServerStreamListener)
method.
Constructor and Description |
---|
SqlInfoBuilder() |
public static NullableVarCharHolder getHolderForUtf8(String string, ArrowBuf buf)
string
- the StandardCharsets.UTF_8
-encoded text input to store onto the holder.buf
- the ArrowBuf
from which to create the new holder.NullableVarCharHolder
with the provided input data string
.public SqlInfoBuilder withFlightSqlServerName(String value)
FlightSql.SqlInfo.FLIGHT_SQL_SERVER_NAME
in the builder.value
- the value for FlightSql.SqlInfo.FLIGHT_SQL_SERVER_NAME
to be set.public SqlInfoBuilder withFlightSqlServerVersion(String value)
FlightSql.SqlInfo.FLIGHT_SQL_SERVER_VERSION
in the builder.value
- the value for FlightSql.SqlInfo.FLIGHT_SQL_SERVER_VERSION
to be set.public SqlInfoBuilder withFlightSqlServerArrowVersion(String value)
FlightSql.SqlInfo.FLIGHT_SQL_SERVER_ARROW_VERSION
in the builder.value
- the value for FlightSql.SqlInfo.FLIGHT_SQL_SERVER_ARROW_VERSION
to be set.public SqlInfoBuilder withFlightSqlServerSql(boolean value)
public SqlInfoBuilder withFlightSqlServerSubstrait(boolean value)
public SqlInfoBuilder withFlightSqlServerSubstraitMinVersion(String value)
public SqlInfoBuilder withFlightSqlServerSubstraitMaxVersion(String value)
public SqlInfoBuilder withFlightSqlServerTransaction(FlightSql.SqlSupportedTransaction value)
public SqlInfoBuilder withFlightSqlServerCancel(boolean value)
public SqlInfoBuilder withFlightSqlServerStatementTimeout(int value)
public SqlInfoBuilder withFlightSqlServerTransactionTimeout(int value)
public SqlInfoBuilder withSqlIdentifierQuoteChar(String value)
FlightSql.SqlInfo.SQL_IDENTIFIER_QUOTE_CHAR
in the builder.value
- the value for FlightSql.SqlInfo.SQL_IDENTIFIER_QUOTE_CHAR
to be set.public SqlInfoBuilder withSqlSearchStringEscape(String value)
FlightSql.SqlInfo.SQL_SEARCH_STRING_ESCAPE
in the builder.value
- the value for FlightSql.SqlInfo.SQL_SEARCH_STRING_ESCAPE
to be set.public SqlInfoBuilder withSqlExtraNameCharacters(String value)
FlightSql.SqlInfo.SQL_EXTRA_NAME_CHARACTERS
in the builder.value
- the value for FlightSql.SqlInfo.SQL_EXTRA_NAME_CHARACTERS
to be set.public SqlInfoBuilder withSqlSchemaTerm(String value)
FlightSql.SqlInfo.SQL_SCHEMA_TERM
in the builder.value
- the value for FlightSql.SqlInfo.SQL_SCHEMA_TERM
to be set.public SqlInfoBuilder withSqlCatalogTerm(String value)
FlightSql.SqlInfo.SQL_CATALOG_TERM
in the builder.value
- the value for FlightSql.SqlInfo.SQL_CATALOG_TERM
to be set.public SqlInfoBuilder withSqlProcedureTerm(String value)
FlightSql.SqlInfo.SQL_PROCEDURE_TERM
in the builder.value
- the value for FlightSql.SqlInfo.SQL_PROCEDURE_TERM
to be set.public SqlInfoBuilder withSqlDdlCatalog(boolean value)
FlightSql.SqlInfo.SQL_DDL_CATALOG
in the builder.value
- the value for FlightSql.SqlInfo.SQL_DDL_CATALOG
to be set.public SqlInfoBuilder withSqlDdlSchema(boolean value)
FlightSql.SqlInfo.SQL_DDL_SCHEMA
in the builder.value
- the value for FlightSql.SqlInfo.SQL_DDL_SCHEMA
to be set.public SqlInfoBuilder withSqlDdlTable(boolean value)
FlightSql.SqlInfo.SQL_DDL_TABLE
in the builder.value
- the value for FlightSql.SqlInfo.SQL_DDL_TABLE
to be set.public SqlInfoBuilder withFlightSqlServerReadOnly(boolean value)
FlightSql.SqlInfo.FLIGHT_SQL_SERVER_READ_ONLY
in the builder.value
- the value for FlightSql.SqlInfo.FLIGHT_SQL_SERVER_READ_ONLY
to be set.public SqlInfoBuilder withSqlSupportsColumnAliasing(boolean value)
FlightSql.SqlInfo.SQL_SUPPORTS_COLUMN_ALIASING
in the builder.value
- the value for FlightSql.SqlInfo.SQL_SUPPORTS_COLUMN_ALIASING
to be set.public SqlInfoBuilder withSqlNullPlusNullIsNull(boolean value)
FlightSql.SqlInfo.SQL_NULL_PLUS_NULL_IS_NULL
in the builder.value
- the value for FlightSql.SqlInfo.SQL_NULL_PLUS_NULL_IS_NULL
to be set.public SqlInfoBuilder withSqlSupportsTableCorrelationNames(boolean value)
FlightSql.SqlInfo.SQL_SUPPORTS_TABLE_CORRELATION_NAMES
in the builder.value
- the value for FlightSql.SqlInfo.SQL_SUPPORTS_TABLE_CORRELATION_NAMES
to be set.public SqlInfoBuilder withSqlSupportsDifferentTableCorrelationNames(boolean value)
FlightSql.SqlInfo.SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES
in the builder.value
- the value for FlightSql.SqlInfo.SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES
to be set.public SqlInfoBuilder withSqlSupportsExpressionsInOrderBy(boolean value)
FlightSql.SqlInfo.SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BY
in the builder.value
- the value for FlightSql.SqlInfo.SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BY
to be set.public SqlInfoBuilder withSqlSupportsOrderByUnrelated(boolean value)
FlightSql.SqlInfo.SQL_SUPPORTS_ORDER_BY_UNRELATED
in the builder.value
- the value for FlightSql.SqlInfo.SQL_SUPPORTS_ORDER_BY_UNRELATED
to be set.public SqlInfoBuilder withSqlSupportsLikeEscapeClause(boolean value)
FlightSql.SqlInfo.SQL_SUPPORTS_LIKE_ESCAPE_CLAUSE
in the builder.value
- the value for FlightSql.SqlInfo.SQL_SUPPORTS_LIKE_ESCAPE_CLAUSE
to be set.public SqlInfoBuilder withSqlSupportsNonNullableColumns(boolean value)
FlightSql.SqlInfo.SQL_SUPPORTS_NON_NULLABLE_COLUMNS
in the builder.value
- the value for FlightSql.SqlInfo.SQL_SUPPORTS_NON_NULLABLE_COLUMNS
to be set.public SqlInfoBuilder withSqlSupportsIntegrityEnhancementFacility(boolean value)
FlightSql.SqlInfo.SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITY
in the builder.value
- the value for FlightSql.SqlInfo.SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITY
to be set.public SqlInfoBuilder withSqlCatalogAtStart(boolean value)
FlightSql.SqlInfo.SQL_CATALOG_AT_START
in the builder.value
- the value for FlightSql.SqlInfo.SQL_CATALOG_AT_START
to be set.public SqlInfoBuilder withSqlSelectForUpdateSupported(boolean value)
FlightSql.SqlInfo.SQL_SELECT_FOR_UPDATE_SUPPORTED
in the builder.value
- the value for FlightSql.SqlInfo.SQL_SELECT_FOR_UPDATE_SUPPORTED
to be set.public SqlInfoBuilder withSqlStoredProceduresSupported(boolean value)
FlightSql.SqlInfo.SQL_STORED_PROCEDURES_SUPPORTED
in the builder.value
- the value for FlightSql.SqlInfo.SQL_STORED_PROCEDURES_SUPPORTED
to be set.public SqlInfoBuilder withSqlCorrelatedSubqueriesSupported(boolean value)
FlightSql.SqlInfo.SQL_CORRELATED_SUBQUERIES_SUPPORTED
in the builder.value
- the value for FlightSql.SqlInfo.SQL_CORRELATED_SUBQUERIES_SUPPORTED
to be set.public SqlInfoBuilder withSqlMaxRowSizeIncludesBlobs(boolean value)
FlightSql.SqlInfo.SQL_MAX_ROW_SIZE_INCLUDES_BLOBS
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_ROW_SIZE_INCLUDES_BLOBS
to be set.public SqlInfoBuilder withSqlTransactionsSupported(boolean value)
FlightSql.SqlInfo.SQL_TRANSACTIONS_SUPPORTED
in the builder.value
- the value for FlightSql.SqlInfo.SQL_TRANSACTIONS_SUPPORTED
to be set.public SqlInfoBuilder withSqlDataDefinitionCausesTransactionCommit(boolean value)
FlightSql.SqlInfo.SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMIT
in the builder.value
- the value for FlightSql.SqlInfo.SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMIT
to be set.public SqlInfoBuilder withSqlDataDefinitionsInTransactionsIgnored(boolean value)
FlightSql.SqlInfo.SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNORED
in the builder.value
- the value for FlightSql.SqlInfo.SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNORED
to be set.public SqlInfoBuilder withSqlBatchUpdatesSupported(boolean value)
FlightSql.SqlInfo.SQL_BATCH_UPDATES_SUPPORTED
in the builder.value
- the value for FlightSql.SqlInfo.SQL_BATCH_UPDATES_SUPPORTED
to be set.public SqlInfoBuilder withSqlSavepointsSupported(boolean value)
value
- the value for FlightSql.SqlInfo.SQL_SAVEPOINTS_SUPPORTED
to be set.public SqlInfoBuilder withSqlNamedParametersSupported(boolean value)
FlightSql.SqlInfo.SQL_NAMED_PARAMETERS_SUPPORTED
in the builder.value
- the value for FlightSql.SqlInfo.SQL_NAMED_PARAMETERS_SUPPORTED
to be set.public SqlInfoBuilder withSqlLocatorsUpdateCopy(boolean value)
FlightSql.SqlInfo.SQL_LOCATORS_UPDATE_COPY
in the builder.value
- the value for FlightSql.SqlInfo.SQL_LOCATORS_UPDATE_COPY
to be set.public SqlInfoBuilder withSqlStoredFunctionsUsingCallSyntaxSupported(boolean value)
FlightSql.SqlInfo.SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTED
in the builder.value
- the value for FlightSql.SqlInfo.SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTED
to be set.public SqlInfoBuilder withSqlIdentifierCase(FlightSql.SqlSupportedCaseSensitivity value)
FlightSql.SqlInfo.SQL_IDENTIFIER_CASE
in the builder.value
- the value for FlightSql.SqlInfo.SQL_IDENTIFIER_CASE
to be set.public SqlInfoBuilder withSqlQuotedIdentifierCase(FlightSql.SqlSupportedCaseSensitivity value)
FlightSql.SqlInfo.SQL_QUOTED_IDENTIFIER_CASE
in the builder.value
- the value for FlightSql.SqlInfo.SQL_QUOTED_IDENTIFIER_CASE
to be set.public SqlInfoBuilder withSqlMaxBinaryLiteralLength(long value)
value
- the value for FlightSql.SqlInfo.SQL_MAX_BINARY_LITERAL_LENGTH
to be set.public SqlInfoBuilder withSqlMaxCharLiteralLength(long value)
FlightSql.SqlInfo.SQL_MAX_CHAR_LITERAL_LENGTH
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_CHAR_LITERAL_LENGTH
to be set.public SqlInfoBuilder withSqlMaxColumnNameLength(long value)
FlightSql.SqlInfo.SQL_MAX_COLUMN_NAME_LENGTH
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_COLUMN_NAME_LENGTH
to be set.public SqlInfoBuilder withSqlMaxColumnsInGroupBy(long value)
FlightSql.SqlInfo.SQL_MAX_COLUMNS_IN_GROUP_BY
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_COLUMNS_IN_GROUP_BY
to be set.public SqlInfoBuilder withSqlMaxColumnsInIndex(long value)
FlightSql.SqlInfo.SQL_MAX_COLUMNS_IN_INDEX
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_COLUMNS_IN_INDEX
to be set.public SqlInfoBuilder withSqlMaxColumnsInOrderBy(long value)
FlightSql.SqlInfo.SQL_MAX_COLUMNS_IN_ORDER_BY
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_COLUMNS_IN_ORDER_BY
to be set.public SqlInfoBuilder withSqlMaxColumnsInSelect(long value)
FlightSql.SqlInfo.SQL_MAX_COLUMNS_IN_SELECT
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_COLUMNS_IN_SELECT
to be set.public SqlInfoBuilder withSqlMaxConnections(long value)
FlightSql.SqlInfo.SQL_MAX_CONNECTIONS
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_CONNECTIONS
to be set.public SqlInfoBuilder withSqlMaxCursorNameLength(long value)
FlightSql.SqlInfo.SQL_MAX_CURSOR_NAME_LENGTH
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_CURSOR_NAME_LENGTH
to be set.public SqlInfoBuilder withSqlMaxIndexLength(long value)
FlightSql.SqlInfo.SQL_MAX_INDEX_LENGTH
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_INDEX_LENGTH
to be set.public SqlInfoBuilder withSqlDbSchemaNameLength(long value)
FlightSql.SqlInfo.SQL_DB_SCHEMA_NAME_LENGTH
in the builder.value
- the value for FlightSql.SqlInfo.SQL_DB_SCHEMA_NAME_LENGTH
to be set.public SqlInfoBuilder withSqlMaxProcedureNameLength(long value)
FlightSql.SqlInfo.SQL_MAX_PROCEDURE_NAME_LENGTH
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_PROCEDURE_NAME_LENGTH
to be set.public SqlInfoBuilder withSqlMaxCatalogNameLength(long value)
FlightSql.SqlInfo.SQL_MAX_CATALOG_NAME_LENGTH
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_CATALOG_NAME_LENGTH
to be set.public SqlInfoBuilder withSqlMaxRowSize(long value)
FlightSql.SqlInfo.SQL_MAX_ROW_SIZE
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_ROW_SIZE
to be set.public SqlInfoBuilder withSqlMaxStatementLength(long value)
FlightSql.SqlInfo.SQL_MAX_STATEMENT_LENGTH
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_STATEMENT_LENGTH
to be set.public SqlInfoBuilder withSqlMaxStatements(long value)
FlightSql.SqlInfo.SQL_MAX_STATEMENTS
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_STATEMENTS
to be set.public SqlInfoBuilder withSqlMaxTableNameLength(long value)
FlightSql.SqlInfo.SQL_MAX_TABLE_NAME_LENGTH
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_TABLE_NAME_LENGTH
to be set.public SqlInfoBuilder withSqlMaxTablesInSelect(long value)
FlightSql.SqlInfo.SQL_MAX_TABLES_IN_SELECT
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_TABLES_IN_SELECT
to be set.public SqlInfoBuilder withSqlMaxUsernameLength(long value)
FlightSql.SqlInfo.SQL_MAX_USERNAME_LENGTH
in the builder.value
- the value for FlightSql.SqlInfo.SQL_MAX_USERNAME_LENGTH
to be set.public SqlInfoBuilder withSqlDefaultTransactionIsolation(long value)
FlightSql.SqlInfo.SQL_DEFAULT_TRANSACTION_ISOLATION
in the builder.value
- the value for FlightSql.SqlInfo.SQL_DEFAULT_TRANSACTION_ISOLATION
to be set.public SqlInfoBuilder withSqlSupportedGroupBy(FlightSql.SqlSupportedGroupBy... values)
FlightSql.SqlInfo.SQL_SUPPORTED_GROUP_BY
in the builder.values
- the value for FlightSql.SqlInfo.SQL_SUPPORTED_GROUP_BY
to be set.public SqlInfoBuilder withSqlSupportedGrammar(FlightSql.SupportedSqlGrammar... values)
FlightSql.SqlInfo.SQL_SUPPORTED_GRAMMAR
in the builder.values
- the value for FlightSql.SqlInfo.SQL_SUPPORTED_GRAMMAR
to be set.public SqlInfoBuilder withSqlAnsi92SupportedLevel(FlightSql.SupportedAnsi92SqlGrammarLevel... values)
FlightSql.SqlInfo.SQL_ANSI92_SUPPORTED_LEVEL
in the builder.values
- the value for FlightSql.SqlInfo.SQL_ANSI92_SUPPORTED_LEVEL
to be set.public SqlInfoBuilder withSqlSchemasSupportedActions(FlightSql.SqlSupportedElementActions... values)
FlightSql.SqlInfo.SQL_SCHEMAS_SUPPORTED_ACTIONS
in the builder.values
- the value for FlightSql.SqlInfo.SQL_SCHEMAS_SUPPORTED_ACTIONS
to be set.public SqlInfoBuilder withSqlCatalogsSupportedActions(FlightSql.SqlSupportedElementActions... values)
FlightSql.SqlInfo.SQL_CATALOGS_SUPPORTED_ACTIONS
in the builder.values
- the value for FlightSql.SqlInfo.SQL_CATALOGS_SUPPORTED_ACTIONS
to be set.public SqlInfoBuilder withSqlSupportedPositionedCommands(FlightSql.SqlSupportedPositionedCommands... values)
FlightSql.SqlInfo.SQL_SUPPORTED_POSITIONED_COMMANDS
in the builder.values
- the value for FlightSql.SqlInfo.SQL_SUPPORTED_POSITIONED_COMMANDS
to be set.public SqlInfoBuilder withSqlSubQueriesSupported(FlightSql.SqlSupportedSubqueries... values)
FlightSql.SqlInfo.SQL_SUPPORTED_SUBQUERIES
in the builder.values
- the value for FlightSql.SqlInfo.SQL_SUPPORTED_SUBQUERIES
to be set.public SqlInfoBuilder withSqlSupportedUnions(FlightSql.SqlSupportedUnions... values)
FlightSql.SqlInfo.SQL_SUPPORTED_UNIONS
in the builder.values
- the values for FlightSql.SqlInfo.SQL_SUPPORTED_UNIONS
to be set.public SqlInfoBuilder withSqlOuterJoinSupportLevel(FlightSql.SqlOuterJoinsSupportLevel... value)
FlightSql.SqlInfo.SQL_OUTER_JOINS_SUPPORT_LEVEL
in the builder.value
- the value for FlightSql.SqlInfo.SQL_OUTER_JOINS_SUPPORT_LEVEL
to be set.public SqlInfoBuilder withSqlSupportedTransactionsIsolationLevels(FlightSql.SqlTransactionIsolationLevel... values)
FlightSql.SqlInfo.SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELS
in the builder.values
- the values for FlightSql.SqlInfo.SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELS
to be set.public SqlInfoBuilder withSqlSupportedResultSetTypes(FlightSql.SqlSupportedResultSetType... values)
FlightSql.SqlInfo.SQL_SUPPORTED_RESULT_SET_TYPES
in the builder.values
- the values for FlightSql.SqlInfo.SQL_SUPPORTED_RESULT_SET_TYPES
to be set.public SqlInfoBuilder withSqlKeywords(String[] value)
FlightSql.SqlInfo.SQL_KEYWORDS
in the builder.value
- the values for FlightSql.SqlInfo.SQL_KEYWORDS
to be set.public SqlInfoBuilder withSqlNumericFunctions(String[] value)
FlightSql.SqlInfo.SQL_NUMERIC_FUNCTIONS
in the builder.value
- the values for FlightSql.SqlInfo.SQL_NUMERIC_FUNCTIONS
to be set.public SqlInfoBuilder withSqlStringFunctions(String[] value)
FlightSql.SqlInfo.SQL_STRING_FUNCTIONS
in the builder.value
- the values for FlightSql.SqlInfo.SQL_STRING_FUNCTIONS
to be set.public SqlInfoBuilder withSqlSystemFunctions(String[] value)
FlightSql.SqlInfo.SQL_SYSTEM_FUNCTIONS
in the builder.value
- the values for FlightSql.SqlInfo.SQL_SYSTEM_FUNCTIONS
to be set.public SqlInfoBuilder withSqlDatetimeFunctions(String[] value)
FlightSql.SqlInfo.SQL_DATETIME_FUNCTIONS
in the builder.value
- the values for FlightSql.SqlInfo.SQL_DATETIME_FUNCTIONS
to be set.public SqlInfoBuilder withSqlSupportsConvert(Map<Integer,List<Integer>> value)
FlightSql.SqlInfo.SQL_SUPPORTS_CONVERT
in the builder.value
- the values for FlightSql.SqlInfo.SQL_SUPPORTS_CONVERT
to be set.public void send(List<Integer> infos, FlightProducer.ServerStreamListener listener)
infos
- List of SqlInfo to be sent.listener
- ServerStreamListener to send data to.Copyright © 2023 The Apache Software Foundation. All rights reserved.