pitrou commented on a change in pull request #11982:
URL: https://github.com/apache/arrow/pull/11982#discussion_r800474567
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,167 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+enum SqlDataType {
Review comment:
Can you comment on what this is? What is an SQL datatype?
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,167 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+enum SqlDataType {
+ SQL_TYPE_UNKNOWN_TYPE = 0;
+ SQL_TYPE_CHAR = 1;
+ SQL_TYPE_NUMERIC = 2;
+ SQL_TYPE_DECIMAL = 3;
+ SQL_TYPE_INTEGER = 4;
+ SQL_TYPE_SMALLINT = 5;
Review comment:
What is the difference here? Why two integer types (could also be 1 or 8
or...).
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,167 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+enum SqlDataType {
+ SQL_TYPE_UNKNOWN_TYPE = 0;
+ SQL_TYPE_CHAR = 1;
+ SQL_TYPE_NUMERIC = 2;
+ SQL_TYPE_DECIMAL = 3;
+ SQL_TYPE_INTEGER = 4;
+ SQL_TYPE_SMALLINT = 5;
+ SQL_TYPE_FLOAT = 6;
+ SQL_TYPE_REAL = 7;
+ SQL_TYPE_DOUBLE = 8;
Review comment:
Why three real/floating-point types?
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,167 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+enum SqlDataType {
+ SQL_TYPE_UNKNOWN_TYPE = 0;
+ SQL_TYPE_CHAR = 1;
+ SQL_TYPE_NUMERIC = 2;
+ SQL_TYPE_DECIMAL = 3;
+ SQL_TYPE_INTEGER = 4;
+ SQL_TYPE_SMALLINT = 5;
+ SQL_TYPE_FLOAT = 6;
+ SQL_TYPE_REAL = 7;
+ SQL_TYPE_DOUBLE = 8;
+ SQL_TYPE_DATETIME = 9;
+ SQL_TYPE_INTERVAL = 10;
+ SQL_TYPE_VARCHAR = 12;
+}
+
+enum SqlDatetimeSubcode {
+ option allow_alias = true;
Review comment:
Hmm, I'm not sure adding convenience aliases in a spec is a good thing.
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,167 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+enum SqlDataType {
+ SQL_TYPE_UNKNOWN_TYPE = 0;
+ SQL_TYPE_CHAR = 1;
+ SQL_TYPE_NUMERIC = 2;
+ SQL_TYPE_DECIMAL = 3;
+ SQL_TYPE_INTEGER = 4;
+ SQL_TYPE_SMALLINT = 5;
+ SQL_TYPE_FLOAT = 6;
+ SQL_TYPE_REAL = 7;
+ SQL_TYPE_DOUBLE = 8;
+ SQL_TYPE_DATETIME = 9;
+ SQL_TYPE_INTERVAL = 10;
+ SQL_TYPE_VARCHAR = 12;
+}
+
+enum SqlDatetimeSubcode {
+ option allow_alias = true;
+ SQL_SUBCODE_UNKNOWN = 0;
+ SQL_SUBCODE_YEAR = 1;
+ SQL_SUBCODE_DATE = 1;
+ SQL_SUBCODE_TIME = 2;
+ SQL_SUBCODE_MONTH = 2;
+ SQL_SUBCODE_TIMESTAMP = 3;
+ SQL_SUBCODE_DAY = 3;
+ SQL_SUBCODE_TIME_WITH_TIMEZONE = 4;
+ SQL_SUBCODE_HOUR = 4;
+ SQL_SUBCODE_TIMESTAMP_WITH_TIMEZONE = 5;
+ SQL_SUBCODE_MINUTE = 5;
+ SQL_SUBCODE_SECOND = 6;
+ SQL_SUBCODE_YEAR_TO_MONTH = 7;
+ SQL_SUBCODE_DAY_TO_HOUR = 8;
+ SQL_SUBCODE_DAY_TO_MINUTE = 9;
+ SQL_SUBCODE_DAY_TO_SECOND = 10;
+ SQL_SUBCODE_HOUR_TO_MINUTE = 11;
+ SQL_SUBCODE_HOUR_TO_SECOND = 12;
+ SQL_SUBCODE_MINUTE_TO_SECOND = 13;
+ SQL_SUBCODE_INTERVAL_YEAR = 101;
+ SQL_SUBCODE_INTERVAL_MONTH = 102;
+ SQL_SUBCODE_INTERVAL_DAY = 103;
+ SQL_SUBCODE_INTERVAL_HOUR = 104;
+ SQL_SUBCODE_INTERVAL_MINUTE = 105;
+ SQL_SUBCODE_INTERVAL_SECOND = 106;
+ SQL_SUBCODE_INTERVAL_YEAR_TO_MONTH = 107;
+ SQL_SUBCODE_INTERVAL_DAY_TO_HOUR = 108;
+ SQL_SUBCODE_INTERVAL_DAY_TO_MINUTE = 109;
+ SQL_SUBCODE_INTERVAL_DAY_TO_SECOND = 110;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_MINUTE = 111;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_SECOND = 112;
+ SQL_SUBCODE_INTERVAL_MINUTE_TO_SECOND = 113;
+}
+
+enum Nullable {
+ /**
+ * Indicates that the fields does not allow the use of null values.
+ */
+ NULLABILITY_NO_NULLS = 0;
+
+ /**
+ * Indicates that the fields allow the use of null values.
+ */
+ NULLABILITY_NULLABLE = 1;
+
+ /**
+ * Indicates that nullability of the fields can not be determined.
+ */
+ NULLABILITY_UNKNOWN = 2;
+}
+
+enum Searchable {
+ /**
+ * Indicates that column can not be used in a WHERE clause.
+ */
+ SEARCHABLE_NONE = 0;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause if it is using a
+ * LIKE predicate.
+ */
+ SEARCHABLE_CHAR = 1;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using other
predicates
+ * except for LIKE.
+ *
+ * - Allowed operators: comparison, quantified comparison, BETWEEN,
+ * DISTINCT, IN, MATCH, and UNIQUE.
+ */
+ SEARCHABLE_BASIC = 2;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using any
operator.
+ */
+ SEARCHABLE_FULL = 3;
+}
+
+/*
+ * Represents a request to retrieve information about data type supported on a
Flight SQL enabled backend.
+ * Used in the command member of FlightDescriptor for the following RPC calls:
+ * - GetSchema: return the schema of the query.
+ * - GetFlightInfo: execute the catalog metadata request.
+ *
+ * The returned schema will be:
+ * <
+ * type_name: utf8 not null (The name of the data type, for example:
VARCHAR, INTEGER, etc),
+ * data_type: int not null (The SQL data type),
+ * column_size: int (The maximum size supported by that column.
+ * In case of numeric types, this represents the maximum
precision.
Review comment:
In what unit? Decimal digits? What if the type has a power-of-two
magnitude limit?
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,167 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+enum SqlDataType {
+ SQL_TYPE_UNKNOWN_TYPE = 0;
+ SQL_TYPE_CHAR = 1;
+ SQL_TYPE_NUMERIC = 2;
+ SQL_TYPE_DECIMAL = 3;
+ SQL_TYPE_INTEGER = 4;
+ SQL_TYPE_SMALLINT = 5;
+ SQL_TYPE_FLOAT = 6;
+ SQL_TYPE_REAL = 7;
+ SQL_TYPE_DOUBLE = 8;
+ SQL_TYPE_DATETIME = 9;
+ SQL_TYPE_INTERVAL = 10;
+ SQL_TYPE_VARCHAR = 12;
+}
+
+enum SqlDatetimeSubcode {
+ option allow_alias = true;
+ SQL_SUBCODE_UNKNOWN = 0;
+ SQL_SUBCODE_YEAR = 1;
+ SQL_SUBCODE_DATE = 1;
+ SQL_SUBCODE_TIME = 2;
+ SQL_SUBCODE_MONTH = 2;
+ SQL_SUBCODE_TIMESTAMP = 3;
+ SQL_SUBCODE_DAY = 3;
+ SQL_SUBCODE_TIME_WITH_TIMEZONE = 4;
+ SQL_SUBCODE_HOUR = 4;
+ SQL_SUBCODE_TIMESTAMP_WITH_TIMEZONE = 5;
+ SQL_SUBCODE_MINUTE = 5;
+ SQL_SUBCODE_SECOND = 6;
+ SQL_SUBCODE_YEAR_TO_MONTH = 7;
+ SQL_SUBCODE_DAY_TO_HOUR = 8;
+ SQL_SUBCODE_DAY_TO_MINUTE = 9;
+ SQL_SUBCODE_DAY_TO_SECOND = 10;
+ SQL_SUBCODE_HOUR_TO_MINUTE = 11;
+ SQL_SUBCODE_HOUR_TO_SECOND = 12;
+ SQL_SUBCODE_MINUTE_TO_SECOND = 13;
+ SQL_SUBCODE_INTERVAL_YEAR = 101;
+ SQL_SUBCODE_INTERVAL_MONTH = 102;
+ SQL_SUBCODE_INTERVAL_DAY = 103;
+ SQL_SUBCODE_INTERVAL_HOUR = 104;
+ SQL_SUBCODE_INTERVAL_MINUTE = 105;
+ SQL_SUBCODE_INTERVAL_SECOND = 106;
+ SQL_SUBCODE_INTERVAL_YEAR_TO_MONTH = 107;
+ SQL_SUBCODE_INTERVAL_DAY_TO_HOUR = 108;
+ SQL_SUBCODE_INTERVAL_DAY_TO_MINUTE = 109;
+ SQL_SUBCODE_INTERVAL_DAY_TO_SECOND = 110;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_MINUTE = 111;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_SECOND = 112;
+ SQL_SUBCODE_INTERVAL_MINUTE_TO_SECOND = 113;
+}
+
+enum Nullable {
+ /**
+ * Indicates that the fields does not allow the use of null values.
+ */
+ NULLABILITY_NO_NULLS = 0;
+
+ /**
+ * Indicates that the fields allow the use of null values.
+ */
+ NULLABILITY_NULLABLE = 1;
+
+ /**
+ * Indicates that nullability of the fields can not be determined.
+ */
+ NULLABILITY_UNKNOWN = 2;
+}
+
+enum Searchable {
+ /**
+ * Indicates that column can not be used in a WHERE clause.
+ */
+ SEARCHABLE_NONE = 0;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause if it is using a
+ * LIKE predicate.
+ */
+ SEARCHABLE_CHAR = 1;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using other
predicates
+ * except for LIKE.
+ *
+ * - Allowed operators: comparison, quantified comparison, BETWEEN,
+ * DISTINCT, IN, MATCH, and UNIQUE.
+ */
+ SEARCHABLE_BASIC = 2;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using any
operator.
+ */
+ SEARCHABLE_FULL = 3;
+}
+
+/*
+ * Represents a request to retrieve information about data type supported on a
Flight SQL enabled backend.
+ * Used in the command member of FlightDescriptor for the following RPC calls:
+ * - GetSchema: return the schema of the query.
+ * - GetFlightInfo: execute the catalog metadata request.
+ *
+ * The returned schema will be:
+ * <
+ * type_name: utf8 not null (The name of the data type, for example:
VARCHAR, INTEGER, etc),
+ * data_type: int not null (The SQL data type),
+ * column_size: int (The maximum size supported by that column.
+ * In case of numeric types, this represents the maximum
precision.
+ * In case of string types, this represents the character
length.
+ * In case of datetime data types, this represents the
length in characters of the string representation.
+ * NULL is returned for data types where column size is
not applicable.),
+ * literal_prefix: utf8 (Character or characters used to prefix a literal,
NULL is returned for
+ * data types where a literal prefix is not
applicable.),
Review comment:
So this applies to SQL-the-query-langage ? Or does this apply to
FlightSQL as well?
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,167 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+enum SqlDataType {
+ SQL_TYPE_UNKNOWN_TYPE = 0;
+ SQL_TYPE_CHAR = 1;
+ SQL_TYPE_NUMERIC = 2;
+ SQL_TYPE_DECIMAL = 3;
+ SQL_TYPE_INTEGER = 4;
+ SQL_TYPE_SMALLINT = 5;
+ SQL_TYPE_FLOAT = 6;
+ SQL_TYPE_REAL = 7;
+ SQL_TYPE_DOUBLE = 8;
+ SQL_TYPE_DATETIME = 9;
+ SQL_TYPE_INTERVAL = 10;
+ SQL_TYPE_VARCHAR = 12;
+}
+
+enum SqlDatetimeSubcode {
+ option allow_alias = true;
+ SQL_SUBCODE_UNKNOWN = 0;
+ SQL_SUBCODE_YEAR = 1;
+ SQL_SUBCODE_DATE = 1;
+ SQL_SUBCODE_TIME = 2;
+ SQL_SUBCODE_MONTH = 2;
+ SQL_SUBCODE_TIMESTAMP = 3;
+ SQL_SUBCODE_DAY = 3;
+ SQL_SUBCODE_TIME_WITH_TIMEZONE = 4;
+ SQL_SUBCODE_HOUR = 4;
+ SQL_SUBCODE_TIMESTAMP_WITH_TIMEZONE = 5;
+ SQL_SUBCODE_MINUTE = 5;
+ SQL_SUBCODE_SECOND = 6;
+ SQL_SUBCODE_YEAR_TO_MONTH = 7;
+ SQL_SUBCODE_DAY_TO_HOUR = 8;
+ SQL_SUBCODE_DAY_TO_MINUTE = 9;
+ SQL_SUBCODE_DAY_TO_SECOND = 10;
+ SQL_SUBCODE_HOUR_TO_MINUTE = 11;
+ SQL_SUBCODE_HOUR_TO_SECOND = 12;
+ SQL_SUBCODE_MINUTE_TO_SECOND = 13;
+ SQL_SUBCODE_INTERVAL_YEAR = 101;
+ SQL_SUBCODE_INTERVAL_MONTH = 102;
+ SQL_SUBCODE_INTERVAL_DAY = 103;
+ SQL_SUBCODE_INTERVAL_HOUR = 104;
+ SQL_SUBCODE_INTERVAL_MINUTE = 105;
+ SQL_SUBCODE_INTERVAL_SECOND = 106;
+ SQL_SUBCODE_INTERVAL_YEAR_TO_MONTH = 107;
+ SQL_SUBCODE_INTERVAL_DAY_TO_HOUR = 108;
+ SQL_SUBCODE_INTERVAL_DAY_TO_MINUTE = 109;
+ SQL_SUBCODE_INTERVAL_DAY_TO_SECOND = 110;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_MINUTE = 111;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_SECOND = 112;
+ SQL_SUBCODE_INTERVAL_MINUTE_TO_SECOND = 113;
+}
+
+enum Nullable {
+ /**
+ * Indicates that the fields does not allow the use of null values.
+ */
+ NULLABILITY_NO_NULLS = 0;
+
+ /**
+ * Indicates that the fields allow the use of null values.
+ */
+ NULLABILITY_NULLABLE = 1;
+
+ /**
+ * Indicates that nullability of the fields can not be determined.
+ */
+ NULLABILITY_UNKNOWN = 2;
+}
+
+enum Searchable {
+ /**
+ * Indicates that column can not be used in a WHERE clause.
+ */
+ SEARCHABLE_NONE = 0;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause if it is using a
+ * LIKE predicate.
+ */
+ SEARCHABLE_CHAR = 1;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using other
predicates
+ * except for LIKE.
+ *
+ * - Allowed operators: comparison, quantified comparison, BETWEEN,
+ * DISTINCT, IN, MATCH, and UNIQUE.
+ */
+ SEARCHABLE_BASIC = 2;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using any
operator.
+ */
+ SEARCHABLE_FULL = 3;
+}
+
+/*
+ * Represents a request to retrieve information about data type supported on a
Flight SQL enabled backend.
+ * Used in the command member of FlightDescriptor for the following RPC calls:
+ * - GetSchema: return the schema of the query.
+ * - GetFlightInfo: execute the catalog metadata request.
+ *
+ * The returned schema will be:
+ * <
+ * type_name: utf8 not null (The name of the data type, for example:
VARCHAR, INTEGER, etc),
+ * data_type: int not null (The SQL data type),
+ * column_size: int (The maximum size supported by that column.
+ * In case of numeric types, this represents the maximum
precision.
+ * In case of string types, this represents the character
length.
+ * In case of datetime data types, this represents the
length in characters of the string representation.
+ * NULL is returned for data types where column size is
not applicable.),
+ * literal_prefix: utf8 (Character or characters used to prefix a literal,
NULL is returned for
+ * data types where a literal prefix is not
applicable.),
+ * literal_suffix: utf8 (Character or characters used to terminate a literal,
+ * NULL is returned for data types where a literal
suffix is not applicable.),
+ * create_params: list<utf8 not null>
+ * (A list of keywords corresponding to which
parameters can be used when creating
+ * a column for that specific type.
+ * NULL is returned if there are no parameters for the
data type definition.),
+ * nullable: int not null (Shows if the data type accepts a NULL value. The
possible values can be seen in the
+ * Nullable enum.),
+ * case_sensitive: bool not null (Shows if a character data type is
case-sensitive in collations and comparisons),
+ * searchable: int not null (Shows how the data type is used in a WHERE
clause. The possible values can be seen in the
+ * Searchable enum.),
+ * unsigned_attribute: bool (Shows if the data type is unsigned. NULL is
returned if the attribute is
+ * not applicable to the data type or the data
type is not numeric.),
+ * fixed_prec_scale: bool not null (Shows if the data type has predefined
fixed precision and scale.),
Review comment:
Hmm, can you explain what this means exactly?
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,167 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+enum SqlDataType {
+ SQL_TYPE_UNKNOWN_TYPE = 0;
+ SQL_TYPE_CHAR = 1;
+ SQL_TYPE_NUMERIC = 2;
+ SQL_TYPE_DECIMAL = 3;
+ SQL_TYPE_INTEGER = 4;
+ SQL_TYPE_SMALLINT = 5;
+ SQL_TYPE_FLOAT = 6;
+ SQL_TYPE_REAL = 7;
+ SQL_TYPE_DOUBLE = 8;
+ SQL_TYPE_DATETIME = 9;
+ SQL_TYPE_INTERVAL = 10;
+ SQL_TYPE_VARCHAR = 12;
Review comment:
No blob or binary?
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,167 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+enum SqlDataType {
+ SQL_TYPE_UNKNOWN_TYPE = 0;
+ SQL_TYPE_CHAR = 1;
+ SQL_TYPE_NUMERIC = 2;
+ SQL_TYPE_DECIMAL = 3;
+ SQL_TYPE_INTEGER = 4;
+ SQL_TYPE_SMALLINT = 5;
+ SQL_TYPE_FLOAT = 6;
+ SQL_TYPE_REAL = 7;
+ SQL_TYPE_DOUBLE = 8;
+ SQL_TYPE_DATETIME = 9;
+ SQL_TYPE_INTERVAL = 10;
+ SQL_TYPE_VARCHAR = 12;
+}
+
+enum SqlDatetimeSubcode {
+ option allow_alias = true;
+ SQL_SUBCODE_UNKNOWN = 0;
+ SQL_SUBCODE_YEAR = 1;
+ SQL_SUBCODE_DATE = 1;
+ SQL_SUBCODE_TIME = 2;
+ SQL_SUBCODE_MONTH = 2;
+ SQL_SUBCODE_TIMESTAMP = 3;
+ SQL_SUBCODE_DAY = 3;
+ SQL_SUBCODE_TIME_WITH_TIMEZONE = 4;
+ SQL_SUBCODE_HOUR = 4;
+ SQL_SUBCODE_TIMESTAMP_WITH_TIMEZONE = 5;
+ SQL_SUBCODE_MINUTE = 5;
+ SQL_SUBCODE_SECOND = 6;
+ SQL_SUBCODE_YEAR_TO_MONTH = 7;
+ SQL_SUBCODE_DAY_TO_HOUR = 8;
+ SQL_SUBCODE_DAY_TO_MINUTE = 9;
+ SQL_SUBCODE_DAY_TO_SECOND = 10;
+ SQL_SUBCODE_HOUR_TO_MINUTE = 11;
+ SQL_SUBCODE_HOUR_TO_SECOND = 12;
+ SQL_SUBCODE_MINUTE_TO_SECOND = 13;
+ SQL_SUBCODE_INTERVAL_YEAR = 101;
+ SQL_SUBCODE_INTERVAL_MONTH = 102;
+ SQL_SUBCODE_INTERVAL_DAY = 103;
+ SQL_SUBCODE_INTERVAL_HOUR = 104;
+ SQL_SUBCODE_INTERVAL_MINUTE = 105;
+ SQL_SUBCODE_INTERVAL_SECOND = 106;
+ SQL_SUBCODE_INTERVAL_YEAR_TO_MONTH = 107;
+ SQL_SUBCODE_INTERVAL_DAY_TO_HOUR = 108;
+ SQL_SUBCODE_INTERVAL_DAY_TO_MINUTE = 109;
+ SQL_SUBCODE_INTERVAL_DAY_TO_SECOND = 110;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_MINUTE = 111;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_SECOND = 112;
+ SQL_SUBCODE_INTERVAL_MINUTE_TO_SECOND = 113;
+}
+
+enum Nullable {
+ /**
+ * Indicates that the fields does not allow the use of null values.
+ */
+ NULLABILITY_NO_NULLS = 0;
+
+ /**
+ * Indicates that the fields allow the use of null values.
+ */
+ NULLABILITY_NULLABLE = 1;
+
+ /**
+ * Indicates that nullability of the fields can not be determined.
+ */
+ NULLABILITY_UNKNOWN = 2;
+}
+
+enum Searchable {
+ /**
+ * Indicates that column can not be used in a WHERE clause.
+ */
+ SEARCHABLE_NONE = 0;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause if it is using a
+ * LIKE predicate.
+ */
+ SEARCHABLE_CHAR = 1;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using other
predicates
+ * except for LIKE.
+ *
+ * - Allowed operators: comparison, quantified comparison, BETWEEN,
+ * DISTINCT, IN, MATCH, and UNIQUE.
+ */
+ SEARCHABLE_BASIC = 2;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using any
operator.
+ */
+ SEARCHABLE_FULL = 3;
+}
+
+/*
+ * Represents a request to retrieve information about data type supported on a
Flight SQL enabled backend.
+ * Used in the command member of FlightDescriptor for the following RPC calls:
+ * - GetSchema: return the schema of the query.
+ * - GetFlightInfo: execute the catalog metadata request.
+ *
+ * The returned schema will be:
+ * <
+ * type_name: utf8 not null (The name of the data type, for example:
VARCHAR, INTEGER, etc),
+ * data_type: int not null (The SQL data type),
+ * column_size: int (The maximum size supported by that column.
+ * In case of numeric types, this represents the maximum
precision.
+ * In case of string types, this represents the character
length.
+ * In case of datetime data types, this represents the
length in characters of the string representation.
+ * NULL is returned for data types where column size is
not applicable.),
+ * literal_prefix: utf8 (Character or characters used to prefix a literal,
NULL is returned for
+ * data types where a literal prefix is not
applicable.),
+ * literal_suffix: utf8 (Character or characters used to terminate a literal,
+ * NULL is returned for data types where a literal
suffix is not applicable.),
+ * create_params: list<utf8 not null>
+ * (A list of keywords corresponding to which
parameters can be used when creating
+ * a column for that specific type.
+ * NULL is returned if there are no parameters for the
data type definition.),
+ * nullable: int not null (Shows if the data type accepts a NULL value. The
possible values can be seen in the
+ * Nullable enum.),
+ * case_sensitive: bool not null (Shows if a character data type is
case-sensitive in collations and comparisons),
+ * searchable: int not null (Shows how the data type is used in a WHERE
clause. The possible values can be seen in the
+ * Searchable enum.),
+ * unsigned_attribute: bool (Shows if the data type is unsigned. NULL is
returned if the attribute is
+ * not applicable to the data type or the data
type is not numeric.),
+ * fixed_prec_scale: bool not null (Shows if the data type has predefined
fixed precision and scale.),
+ * auto_increment: bool (Shows if the data type is auto incremental. NULL is
returned if the attribute
+ * is not applicable to the data type or the data type
is not numeric.),
+ * local_type_name: utf8 (Localized version of the data source-dependent
name of the data type. NULL
+ * is returned if a localized name is not supported
by the data source),
Review comment:
Is there a single "localized" name? AFAIK, databases sometimes accept
multiple aliases for a given datatype.
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,167 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+enum SqlDataType {
+ SQL_TYPE_UNKNOWN_TYPE = 0;
+ SQL_TYPE_CHAR = 1;
+ SQL_TYPE_NUMERIC = 2;
+ SQL_TYPE_DECIMAL = 3;
+ SQL_TYPE_INTEGER = 4;
+ SQL_TYPE_SMALLINT = 5;
+ SQL_TYPE_FLOAT = 6;
+ SQL_TYPE_REAL = 7;
+ SQL_TYPE_DOUBLE = 8;
+ SQL_TYPE_DATETIME = 9;
+ SQL_TYPE_INTERVAL = 10;
+ SQL_TYPE_VARCHAR = 12;
+}
+
+enum SqlDatetimeSubcode {
+ option allow_alias = true;
+ SQL_SUBCODE_UNKNOWN = 0;
+ SQL_SUBCODE_YEAR = 1;
+ SQL_SUBCODE_DATE = 1;
+ SQL_SUBCODE_TIME = 2;
+ SQL_SUBCODE_MONTH = 2;
+ SQL_SUBCODE_TIMESTAMP = 3;
+ SQL_SUBCODE_DAY = 3;
+ SQL_SUBCODE_TIME_WITH_TIMEZONE = 4;
+ SQL_SUBCODE_HOUR = 4;
+ SQL_SUBCODE_TIMESTAMP_WITH_TIMEZONE = 5;
+ SQL_SUBCODE_MINUTE = 5;
+ SQL_SUBCODE_SECOND = 6;
+ SQL_SUBCODE_YEAR_TO_MONTH = 7;
+ SQL_SUBCODE_DAY_TO_HOUR = 8;
+ SQL_SUBCODE_DAY_TO_MINUTE = 9;
+ SQL_SUBCODE_DAY_TO_SECOND = 10;
+ SQL_SUBCODE_HOUR_TO_MINUTE = 11;
+ SQL_SUBCODE_HOUR_TO_SECOND = 12;
+ SQL_SUBCODE_MINUTE_TO_SECOND = 13;
+ SQL_SUBCODE_INTERVAL_YEAR = 101;
+ SQL_SUBCODE_INTERVAL_MONTH = 102;
+ SQL_SUBCODE_INTERVAL_DAY = 103;
+ SQL_SUBCODE_INTERVAL_HOUR = 104;
+ SQL_SUBCODE_INTERVAL_MINUTE = 105;
+ SQL_SUBCODE_INTERVAL_SECOND = 106;
+ SQL_SUBCODE_INTERVAL_YEAR_TO_MONTH = 107;
+ SQL_SUBCODE_INTERVAL_DAY_TO_HOUR = 108;
+ SQL_SUBCODE_INTERVAL_DAY_TO_MINUTE = 109;
+ SQL_SUBCODE_INTERVAL_DAY_TO_SECOND = 110;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_MINUTE = 111;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_SECOND = 112;
+ SQL_SUBCODE_INTERVAL_MINUTE_TO_SECOND = 113;
+}
+
+enum Nullable {
+ /**
+ * Indicates that the fields does not allow the use of null values.
+ */
+ NULLABILITY_NO_NULLS = 0;
+
+ /**
+ * Indicates that the fields allow the use of null values.
+ */
+ NULLABILITY_NULLABLE = 1;
+
+ /**
+ * Indicates that nullability of the fields can not be determined.
+ */
+ NULLABILITY_UNKNOWN = 2;
+}
+
+enum Searchable {
+ /**
+ * Indicates that column can not be used in a WHERE clause.
+ */
+ SEARCHABLE_NONE = 0;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause if it is using a
+ * LIKE predicate.
+ */
+ SEARCHABLE_CHAR = 1;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using other
predicates
+ * except for LIKE.
+ *
+ * - Allowed operators: comparison, quantified comparison, BETWEEN,
+ * DISTINCT, IN, MATCH, and UNIQUE.
+ */
+ SEARCHABLE_BASIC = 2;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using any
operator.
+ */
+ SEARCHABLE_FULL = 3;
+}
+
+/*
+ * Represents a request to retrieve information about data type supported on a
Flight SQL enabled backend.
+ * Used in the command member of FlightDescriptor for the following RPC calls:
+ * - GetSchema: return the schema of the query.
+ * - GetFlightInfo: execute the catalog metadata request.
+ *
+ * The returned schema will be:
+ * <
+ * type_name: utf8 not null (The name of the data type, for example:
VARCHAR, INTEGER, etc),
+ * data_type: int not null (The SQL data type),
+ * column_size: int (The maximum size supported by that column.
+ * In case of numeric types, this represents the maximum
precision.
+ * In case of string types, this represents the character
length.
+ * In case of datetime data types, this represents the
length in characters of the string representation.
+ * NULL is returned for data types where column size is
not applicable.),
+ * literal_prefix: utf8 (Character or characters used to prefix a literal,
NULL is returned for
+ * data types where a literal prefix is not
applicable.),
+ * literal_suffix: utf8 (Character or characters used to terminate a literal,
+ * NULL is returned for data types where a literal
suffix is not applicable.),
+ * create_params: list<utf8 not null>
+ * (A list of keywords corresponding to which
parameters can be used when creating
+ * a column for that specific type.
+ * NULL is returned if there are no parameters for the
data type definition.),
+ * nullable: int not null (Shows if the data type accepts a NULL value. The
possible values can be seen in the
+ * Nullable enum.),
+ * case_sensitive: bool not null (Shows if a character data type is
case-sensitive in collations and comparisons),
+ * searchable: int not null (Shows how the data type is used in a WHERE
clause. The possible values can be seen in the
+ * Searchable enum.),
+ * unsigned_attribute: bool (Shows if the data type is unsigned. NULL is
returned if the attribute is
+ * not applicable to the data type or the data
type is not numeric.),
+ * fixed_prec_scale: bool not null (Shows if the data type has predefined
fixed precision and scale.),
+ * auto_increment: bool (Shows if the data type is auto incremental. NULL is
returned if the attribute
+ * is not applicable to the data type or the data type
is not numeric.),
+ * local_type_name: utf8 (Localized version of the data source-dependent
name of the data type. NULL
+ * is returned if a localized name is not supported
by the data source),
+ * minimum_scale: int (The minimum scale of the data type on the data source.
+ * If a data type has a fixed scale, the MINIMUM_SCALE
and MAXIMUM_SCALE
+ * columns both contain this value. NULL is returned if
scale is not applicable.),
+ * maximum_scale: int (The maximum scale of the data type on the data source.
+ * NULL is returned if scale is not applicable.),
+ * sql_data_type: int not null (The value of the SQL DATA TYPE which has the
same values
+ * as date_type value. Except for interval and
datetime, which
+ * uses generic values. More info about those
types can be
+ * obtained through datetime_subcode. The
possible values can be seen
+ * in the SqlDataType enum.),
+ * datetime_subcode: int (Only used when the SQL DATA TYPE is interval or
datetime. It contains
+ * its sub types. For type different from interval
and datetime, this value
+ * is NULL. The possible values can be seen in the
DateSubcode enum.),
+ * num_prec_radix: int (If the data type is an approximate numeric type,
this column contains
+ * the value 2 to indicate that COLUMN_SIZE specifies a
number of bits. For
Review comment:
You mean column_size (lowercase)?
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,167 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+enum SqlDataType {
+ SQL_TYPE_UNKNOWN_TYPE = 0;
+ SQL_TYPE_CHAR = 1;
+ SQL_TYPE_NUMERIC = 2;
+ SQL_TYPE_DECIMAL = 3;
+ SQL_TYPE_INTEGER = 4;
+ SQL_TYPE_SMALLINT = 5;
+ SQL_TYPE_FLOAT = 6;
+ SQL_TYPE_REAL = 7;
+ SQL_TYPE_DOUBLE = 8;
+ SQL_TYPE_DATETIME = 9;
+ SQL_TYPE_INTERVAL = 10;
+ SQL_TYPE_VARCHAR = 12;
+}
+
+enum SqlDatetimeSubcode {
+ option allow_alias = true;
+ SQL_SUBCODE_UNKNOWN = 0;
+ SQL_SUBCODE_YEAR = 1;
+ SQL_SUBCODE_DATE = 1;
+ SQL_SUBCODE_TIME = 2;
+ SQL_SUBCODE_MONTH = 2;
+ SQL_SUBCODE_TIMESTAMP = 3;
+ SQL_SUBCODE_DAY = 3;
+ SQL_SUBCODE_TIME_WITH_TIMEZONE = 4;
+ SQL_SUBCODE_HOUR = 4;
+ SQL_SUBCODE_TIMESTAMP_WITH_TIMEZONE = 5;
+ SQL_SUBCODE_MINUTE = 5;
+ SQL_SUBCODE_SECOND = 6;
+ SQL_SUBCODE_YEAR_TO_MONTH = 7;
+ SQL_SUBCODE_DAY_TO_HOUR = 8;
+ SQL_SUBCODE_DAY_TO_MINUTE = 9;
+ SQL_SUBCODE_DAY_TO_SECOND = 10;
+ SQL_SUBCODE_HOUR_TO_MINUTE = 11;
+ SQL_SUBCODE_HOUR_TO_SECOND = 12;
+ SQL_SUBCODE_MINUTE_TO_SECOND = 13;
+ SQL_SUBCODE_INTERVAL_YEAR = 101;
+ SQL_SUBCODE_INTERVAL_MONTH = 102;
+ SQL_SUBCODE_INTERVAL_DAY = 103;
+ SQL_SUBCODE_INTERVAL_HOUR = 104;
+ SQL_SUBCODE_INTERVAL_MINUTE = 105;
+ SQL_SUBCODE_INTERVAL_SECOND = 106;
+ SQL_SUBCODE_INTERVAL_YEAR_TO_MONTH = 107;
+ SQL_SUBCODE_INTERVAL_DAY_TO_HOUR = 108;
+ SQL_SUBCODE_INTERVAL_DAY_TO_MINUTE = 109;
+ SQL_SUBCODE_INTERVAL_DAY_TO_SECOND = 110;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_MINUTE = 111;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_SECOND = 112;
+ SQL_SUBCODE_INTERVAL_MINUTE_TO_SECOND = 113;
+}
+
+enum Nullable {
+ /**
+ * Indicates that the fields does not allow the use of null values.
+ */
+ NULLABILITY_NO_NULLS = 0;
+
+ /**
+ * Indicates that the fields allow the use of null values.
+ */
+ NULLABILITY_NULLABLE = 1;
+
+ /**
+ * Indicates that nullability of the fields can not be determined.
+ */
+ NULLABILITY_UNKNOWN = 2;
+}
+
+enum Searchable {
+ /**
+ * Indicates that column can not be used in a WHERE clause.
+ */
+ SEARCHABLE_NONE = 0;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause if it is using a
+ * LIKE predicate.
+ */
+ SEARCHABLE_CHAR = 1;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using other
predicates
+ * except for LIKE.
+ *
+ * - Allowed operators: comparison, quantified comparison, BETWEEN,
+ * DISTINCT, IN, MATCH, and UNIQUE.
+ */
+ SEARCHABLE_BASIC = 2;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using any
operator.
+ */
+ SEARCHABLE_FULL = 3;
+}
+
+/*
+ * Represents a request to retrieve information about data type supported on a
Flight SQL enabled backend.
+ * Used in the command member of FlightDescriptor for the following RPC calls:
+ * - GetSchema: return the schema of the query.
+ * - GetFlightInfo: execute the catalog metadata request.
+ *
+ * The returned schema will be:
+ * <
+ * type_name: utf8 not null (The name of the data type, for example:
VARCHAR, INTEGER, etc),
+ * data_type: int not null (The SQL data type),
+ * column_size: int (The maximum size supported by that column.
+ * In case of numeric types, this represents the maximum
precision.
+ * In case of string types, this represents the character
length.
+ * In case of datetime data types, this represents the
length in characters of the string representation.
+ * NULL is returned for data types where column size is
not applicable.),
+ * literal_prefix: utf8 (Character or characters used to prefix a literal,
NULL is returned for
+ * data types where a literal prefix is not
applicable.),
+ * literal_suffix: utf8 (Character or characters used to terminate a literal,
+ * NULL is returned for data types where a literal
suffix is not applicable.),
+ * create_params: list<utf8 not null>
+ * (A list of keywords corresponding to which
parameters can be used when creating
+ * a column for that specific type.
+ * NULL is returned if there are no parameters for the
data type definition.),
+ * nullable: int not null (Shows if the data type accepts a NULL value. The
possible values can be seen in the
+ * Nullable enum.),
+ * case_sensitive: bool not null (Shows if a character data type is
case-sensitive in collations and comparisons),
+ * searchable: int not null (Shows how the data type is used in a WHERE
clause. The possible values can be seen in the
+ * Searchable enum.),
+ * unsigned_attribute: bool (Shows if the data type is unsigned. NULL is
returned if the attribute is
+ * not applicable to the data type or the data
type is not numeric.),
+ * fixed_prec_scale: bool not null (Shows if the data type has predefined
fixed precision and scale.),
+ * auto_increment: bool (Shows if the data type is auto incremental. NULL is
returned if the attribute
+ * is not applicable to the data type or the data type
is not numeric.),
+ * local_type_name: utf8 (Localized version of the data source-dependent
name of the data type. NULL
+ * is returned if a localized name is not supported
by the data source),
+ * minimum_scale: int (The minimum scale of the data type on the data source.
+ * If a data type has a fixed scale, the MINIMUM_SCALE
and MAXIMUM_SCALE
+ * columns both contain this value. NULL is returned if
scale is not applicable.),
+ * maximum_scale: int (The maximum scale of the data type on the data source.
+ * NULL is returned if scale is not applicable.),
+ * sql_data_type: int not null (The value of the SQL DATA TYPE which has the
same values
+ * as date_type value. Except for interval and
datetime, which
+ * uses generic values. More info about those
types can be
+ * obtained through datetime_subcode. The
possible values can be seen
+ * in the SqlDataType enum.),
+ * datetime_subcode: int (Only used when the SQL DATA TYPE is interval or
datetime. It contains
+ * its sub types. For type different from interval
and datetime, this value
+ * is NULL. The possible values can be seen in the
DateSubcode enum.),
+ * num_prec_radix: int (If the data type is an approximate numeric type,
this column contains
+ * the value 2 to indicate that COLUMN_SIZE specifies a
number of bits. For
+ * exact numeric types, this column contains the value
10 to indicate that
+ * COLUMN_SIZE specifies a number of decimal digits.
Otherwise, this column is NULL.),
+ * interval_precision: int (If the data type is an interval data type, then
this column contains the value
+ * of the interval leading precision. Otherwise,
this column is NULL)
Review comment:
Hmm, what is an interval leading precision?
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,167 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+enum SqlDataType {
+ SQL_TYPE_UNKNOWN_TYPE = 0;
+ SQL_TYPE_CHAR = 1;
+ SQL_TYPE_NUMERIC = 2;
+ SQL_TYPE_DECIMAL = 3;
+ SQL_TYPE_INTEGER = 4;
+ SQL_TYPE_SMALLINT = 5;
+ SQL_TYPE_FLOAT = 6;
+ SQL_TYPE_REAL = 7;
+ SQL_TYPE_DOUBLE = 8;
+ SQL_TYPE_DATETIME = 9;
+ SQL_TYPE_INTERVAL = 10;
+ SQL_TYPE_VARCHAR = 12;
+}
+
+enum SqlDatetimeSubcode {
+ option allow_alias = true;
+ SQL_SUBCODE_UNKNOWN = 0;
+ SQL_SUBCODE_YEAR = 1;
+ SQL_SUBCODE_DATE = 1;
+ SQL_SUBCODE_TIME = 2;
+ SQL_SUBCODE_MONTH = 2;
+ SQL_SUBCODE_TIMESTAMP = 3;
+ SQL_SUBCODE_DAY = 3;
+ SQL_SUBCODE_TIME_WITH_TIMEZONE = 4;
+ SQL_SUBCODE_HOUR = 4;
+ SQL_SUBCODE_TIMESTAMP_WITH_TIMEZONE = 5;
+ SQL_SUBCODE_MINUTE = 5;
+ SQL_SUBCODE_SECOND = 6;
+ SQL_SUBCODE_YEAR_TO_MONTH = 7;
+ SQL_SUBCODE_DAY_TO_HOUR = 8;
+ SQL_SUBCODE_DAY_TO_MINUTE = 9;
+ SQL_SUBCODE_DAY_TO_SECOND = 10;
+ SQL_SUBCODE_HOUR_TO_MINUTE = 11;
+ SQL_SUBCODE_HOUR_TO_SECOND = 12;
+ SQL_SUBCODE_MINUTE_TO_SECOND = 13;
+ SQL_SUBCODE_INTERVAL_YEAR = 101;
+ SQL_SUBCODE_INTERVAL_MONTH = 102;
+ SQL_SUBCODE_INTERVAL_DAY = 103;
+ SQL_SUBCODE_INTERVAL_HOUR = 104;
+ SQL_SUBCODE_INTERVAL_MINUTE = 105;
+ SQL_SUBCODE_INTERVAL_SECOND = 106;
+ SQL_SUBCODE_INTERVAL_YEAR_TO_MONTH = 107;
+ SQL_SUBCODE_INTERVAL_DAY_TO_HOUR = 108;
+ SQL_SUBCODE_INTERVAL_DAY_TO_MINUTE = 109;
+ SQL_SUBCODE_INTERVAL_DAY_TO_SECOND = 110;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_MINUTE = 111;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_SECOND = 112;
+ SQL_SUBCODE_INTERVAL_MINUTE_TO_SECOND = 113;
+}
+
+enum Nullable {
+ /**
+ * Indicates that the fields does not allow the use of null values.
+ */
+ NULLABILITY_NO_NULLS = 0;
+
+ /**
+ * Indicates that the fields allow the use of null values.
+ */
+ NULLABILITY_NULLABLE = 1;
+
+ /**
+ * Indicates that nullability of the fields can not be determined.
+ */
+ NULLABILITY_UNKNOWN = 2;
+}
+
+enum Searchable {
+ /**
+ * Indicates that column can not be used in a WHERE clause.
+ */
+ SEARCHABLE_NONE = 0;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause if it is using a
+ * LIKE predicate.
+ */
+ SEARCHABLE_CHAR = 1;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using other
predicates
+ * except for LIKE.
+ *
+ * - Allowed operators: comparison, quantified comparison, BETWEEN,
+ * DISTINCT, IN, MATCH, and UNIQUE.
+ */
+ SEARCHABLE_BASIC = 2;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using any
operator.
+ */
+ SEARCHABLE_FULL = 3;
+}
+
+/*
+ * Represents a request to retrieve information about data type supported on a
Flight SQL enabled backend.
+ * Used in the command member of FlightDescriptor for the following RPC calls:
+ * - GetSchema: return the schema of the query.
+ * - GetFlightInfo: execute the catalog metadata request.
+ *
+ * The returned schema will be:
+ * <
+ * type_name: utf8 not null (The name of the data type, for example:
VARCHAR, INTEGER, etc),
+ * data_type: int not null (The SQL data type),
+ * column_size: int (The maximum size supported by that column.
+ * In case of numeric types, this represents the maximum
precision.
+ * In case of string types, this represents the character
length.
+ * In case of datetime data types, this represents the
length in characters of the string representation.
+ * NULL is returned for data types where column size is
not applicable.),
+ * literal_prefix: utf8 (Character or characters used to prefix a literal,
NULL is returned for
+ * data types where a literal prefix is not
applicable.),
+ * literal_suffix: utf8 (Character or characters used to terminate a literal,
+ * NULL is returned for data types where a literal
suffix is not applicable.),
+ * create_params: list<utf8 not null>
+ * (A list of keywords corresponding to which
parameters can be used when creating
+ * a column for that specific type.
+ * NULL is returned if there are no parameters for the
data type definition.),
+ * nullable: int not null (Shows if the data type accepts a NULL value. The
possible values can be seen in the
+ * Nullable enum.),
+ * case_sensitive: bool not null (Shows if a character data type is
case-sensitive in collations and comparisons),
+ * searchable: int not null (Shows how the data type is used in a WHERE
clause. The possible values can be seen in the
+ * Searchable enum.),
+ * unsigned_attribute: bool (Shows if the data type is unsigned. NULL is
returned if the attribute is
+ * not applicable to the data type or the data
type is not numeric.),
+ * fixed_prec_scale: bool not null (Shows if the data type has predefined
fixed precision and scale.),
+ * auto_increment: bool (Shows if the data type is auto incremental. NULL is
returned if the attribute
+ * is not applicable to the data type or the data type
is not numeric.),
+ * local_type_name: utf8 (Localized version of the data source-dependent
name of the data type. NULL
+ * is returned if a localized name is not supported
by the data source),
+ * minimum_scale: int (The minimum scale of the data type on the data source.
+ * If a data type has a fixed scale, the MINIMUM_SCALE
and MAXIMUM_SCALE
+ * columns both contain this value. NULL is returned if
scale is not applicable.),
+ * maximum_scale: int (The maximum scale of the data type on the data source.
+ * NULL is returned if scale is not applicable.),
+ * sql_data_type: int not null (The value of the SQL DATA TYPE which has the
same values
+ * as date_type value. Except for interval and
datetime, which
+ * uses generic values. More info about those
types can be
+ * obtained through datetime_subcode. The
possible values can be seen
+ * in the SqlDataType enum.),
+ * datetime_subcode: int (Only used when the SQL DATA TYPE is interval or
datetime. It contains
+ * its sub types. For type different from interval
and datetime, this value
+ * is NULL. The possible values can be seen in the
DateSubcode enum.),
Review comment:
Perhaps make a `sql_data_type: struct (code: int not null, subcode: int)
not null` column instead?
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,45 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+/*
+ * Represents a request to retrieve information about data type supported ona
Flight SQL enabled backend.
+ * Used in the command member of FlightDescriptor for the following RPC calls:
+ * - GetSchema: return the schema of the query.
+ * - GetFlightInfo: execute the catalog metadata request.
+ *
+ * The returned schema will be:
+ * <
+ * type_name: utf8 not null,
+ * data_type: int not null,
+ * column_size: int,
+ * literal_prefix: utf8,
+ * literal_suffix: utf8,
+ * create_params: utf8
+ * nullable: int not null,
+ * case_sensitive: bool null,
+ * searchable: int not null,
+ * unsigned_attribute: bool,
+ * fixed_prec_scale: bool null,
+ * auto_increment: bool,
+ * local_type_name: utf8,
+ * minimum_scale: int,
+ * maximum_scale: int,
+ * sql_data_type: int not null,
+ * sql_datetime_sub: int,
+ * num_prec_radix: int,
+ * interval_precision. int
+ * >
+ * The returned data should be ordered by data_type and then by type_name.
+ */
+message CommandGetTypeInfo {
+ option (experimental) = true;
+
+ /*
+ * Specifies the data type to search for the info.
+ */
+ optional int32 data_type = 1;
Review comment:
I see this conversation is resolved but I still don't understand how the
caller is supposed to choose which data type integer value to pass here?
##########
File path: format/FlightSql.proto
##########
@@ -867,6 +867,167 @@ enum SqlSupportsConvert {
SQL_CONVERT_VARCHAR = 19;
}
+enum SqlDataType {
+ SQL_TYPE_UNKNOWN_TYPE = 0;
+ SQL_TYPE_CHAR = 1;
+ SQL_TYPE_NUMERIC = 2;
+ SQL_TYPE_DECIMAL = 3;
+ SQL_TYPE_INTEGER = 4;
+ SQL_TYPE_SMALLINT = 5;
+ SQL_TYPE_FLOAT = 6;
+ SQL_TYPE_REAL = 7;
+ SQL_TYPE_DOUBLE = 8;
+ SQL_TYPE_DATETIME = 9;
+ SQL_TYPE_INTERVAL = 10;
+ SQL_TYPE_VARCHAR = 12;
+}
+
+enum SqlDatetimeSubcode {
+ option allow_alias = true;
+ SQL_SUBCODE_UNKNOWN = 0;
+ SQL_SUBCODE_YEAR = 1;
+ SQL_SUBCODE_DATE = 1;
+ SQL_SUBCODE_TIME = 2;
+ SQL_SUBCODE_MONTH = 2;
+ SQL_SUBCODE_TIMESTAMP = 3;
+ SQL_SUBCODE_DAY = 3;
+ SQL_SUBCODE_TIME_WITH_TIMEZONE = 4;
+ SQL_SUBCODE_HOUR = 4;
+ SQL_SUBCODE_TIMESTAMP_WITH_TIMEZONE = 5;
+ SQL_SUBCODE_MINUTE = 5;
+ SQL_SUBCODE_SECOND = 6;
+ SQL_SUBCODE_YEAR_TO_MONTH = 7;
+ SQL_SUBCODE_DAY_TO_HOUR = 8;
+ SQL_SUBCODE_DAY_TO_MINUTE = 9;
+ SQL_SUBCODE_DAY_TO_SECOND = 10;
+ SQL_SUBCODE_HOUR_TO_MINUTE = 11;
+ SQL_SUBCODE_HOUR_TO_SECOND = 12;
+ SQL_SUBCODE_MINUTE_TO_SECOND = 13;
+ SQL_SUBCODE_INTERVAL_YEAR = 101;
+ SQL_SUBCODE_INTERVAL_MONTH = 102;
+ SQL_SUBCODE_INTERVAL_DAY = 103;
+ SQL_SUBCODE_INTERVAL_HOUR = 104;
+ SQL_SUBCODE_INTERVAL_MINUTE = 105;
+ SQL_SUBCODE_INTERVAL_SECOND = 106;
+ SQL_SUBCODE_INTERVAL_YEAR_TO_MONTH = 107;
+ SQL_SUBCODE_INTERVAL_DAY_TO_HOUR = 108;
+ SQL_SUBCODE_INTERVAL_DAY_TO_MINUTE = 109;
+ SQL_SUBCODE_INTERVAL_DAY_TO_SECOND = 110;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_MINUTE = 111;
+ SQL_SUBCODE_INTERVAL_HOUR_TO_SECOND = 112;
+ SQL_SUBCODE_INTERVAL_MINUTE_TO_SECOND = 113;
+}
+
+enum Nullable {
+ /**
+ * Indicates that the fields does not allow the use of null values.
+ */
+ NULLABILITY_NO_NULLS = 0;
+
+ /**
+ * Indicates that the fields allow the use of null values.
+ */
+ NULLABILITY_NULLABLE = 1;
+
+ /**
+ * Indicates that nullability of the fields can not be determined.
+ */
+ NULLABILITY_UNKNOWN = 2;
+}
+
+enum Searchable {
+ /**
+ * Indicates that column can not be used in a WHERE clause.
+ */
+ SEARCHABLE_NONE = 0;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause if it is using a
+ * LIKE predicate.
+ */
+ SEARCHABLE_CHAR = 1;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using other
predicates
+ * except for LIKE.
+ *
+ * - Allowed operators: comparison, quantified comparison, BETWEEN,
+ * DISTINCT, IN, MATCH, and UNIQUE.
+ */
+ SEARCHABLE_BASIC = 2;
+
+ /**
+ * Indicates that the column can be used in a WHERE clause using any
operator.
+ */
+ SEARCHABLE_FULL = 3;
+}
+
+/*
+ * Represents a request to retrieve information about data type supported on a
Flight SQL enabled backend.
+ * Used in the command member of FlightDescriptor for the following RPC calls:
+ * - GetSchema: return the schema of the query.
+ * - GetFlightInfo: execute the catalog metadata request.
+ *
+ * The returned schema will be:
+ * <
+ * type_name: utf8 not null (The name of the data type, for example:
VARCHAR, INTEGER, etc),
+ * data_type: int not null (The SQL data type),
+ * column_size: int (The maximum size supported by that column.
+ * In case of numeric types, this represents the maximum
precision.
+ * In case of string types, this represents the character
length.
+ * In case of datetime data types, this represents the
length in characters of the string representation.
+ * NULL is returned for data types where column size is
not applicable.),
+ * literal_prefix: utf8 (Character or characters used to prefix a literal,
NULL is returned for
+ * data types where a literal prefix is not
applicable.),
+ * literal_suffix: utf8 (Character or characters used to terminate a literal,
+ * NULL is returned for data types where a literal
suffix is not applicable.),
+ * create_params: list<utf8 not null>
+ * (A list of keywords corresponding to which
parameters can be used when creating
+ * a column for that specific type.
+ * NULL is returned if there are no parameters for the
data type definition.),
+ * nullable: int not null (Shows if the data type accepts a NULL value. The
possible values can be seen in the
+ * Nullable enum.),
+ * case_sensitive: bool not null (Shows if a character data type is
case-sensitive in collations and comparisons),
+ * searchable: int not null (Shows how the data type is used in a WHERE
clause. The possible values can be seen in the
+ * Searchable enum.),
+ * unsigned_attribute: bool (Shows if the data type is unsigned. NULL is
returned if the attribute is
+ * not applicable to the data type or the data
type is not numeric.),
+ * fixed_prec_scale: bool not null (Shows if the data type has predefined
fixed precision and scale.),
+ * auto_increment: bool (Shows if the data type is auto incremental. NULL is
returned if the attribute
+ * is not applicable to the data type or the data type
is not numeric.),
+ * local_type_name: utf8 (Localized version of the data source-dependent
name of the data type. NULL
+ * is returned if a localized name is not supported
by the data source),
+ * minimum_scale: int (The minimum scale of the data type on the data source.
+ * If a data type has a fixed scale, the MINIMUM_SCALE
and MAXIMUM_SCALE
+ * columns both contain this value. NULL is returned if
scale is not applicable.),
+ * maximum_scale: int (The maximum scale of the data type on the data source.
+ * NULL is returned if scale is not applicable.),
+ * sql_data_type: int not null (The value of the SQL DATA TYPE which has the
same values
+ * as date_type value. Except for interval and
datetime, which
+ * uses generic values. More info about those
types can be
+ * obtained through datetime_subcode. The
possible values can be seen
+ * in the SqlDataType enum.),
+ * datetime_subcode: int (Only used when the SQL DATA TYPE is interval or
datetime. It contains
+ * its sub types. For type different from interval
and datetime, this value
+ * is NULL. The possible values can be seen in the
DateSubcode enum.),
+ * num_prec_radix: int (If the data type is an approximate numeric type,
this column contains
+ * the value 2 to indicate that COLUMN_SIZE specifies a
number of bits. For
Review comment:
Perhaps make column_size a `struct(size: int, radix: int)` instead?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
