Skip to content

Commit 81d6d1e

Browse files
committed
add more
1 parent c8d1ce8 commit 81d6d1e

1 file changed

Lines changed: 28 additions & 8 deletions

File tree

c/include/arrow-adbc/adbc.h

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1977,17 +1977,25 @@ AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection,
19771977
///
19781978
/// The result is an Arrow dataset with the following schema:
19791979
///
1980-
/// | Field Name | Field Type |
1981-
/// |--------------------------|-------------------------|
1982-
/// | catalog_name | utf8 |
1983-
/// | catalog_db_schemas | list<DB_SCHEMA_SCHEMA> |
1980+
/// | Field Name | Field Type | Comments |
1981+
/// |--------------------------|-------------------------|----------|
1982+
/// | catalog_name | utf8 | |
1983+
/// | catalog_db_schemas | list<DB_SCHEMA_SCHEMA> | |
1984+
/// | remarks | utf8 | (1) |
1985+
///
1986+
/// 1. [Since version 1.2.0] A description of the catalog. This field is
1987+
/// optional.
19841988
///
19851989
/// DB_SCHEMA_SCHEMA is a Struct with fields:
19861990
///
1987-
/// | Field Name | Field Type |
1988-
/// |--------------------------|-------------------------|
1989-
/// | db_schema_name | utf8 |
1990-
/// | db_schema_tables | list<TABLE_SCHEMA> |
1991+
/// | Field Name | Field Type | Comments |
1992+
/// |--------------------------|-------------------------|----------|
1993+
/// | db_schema_name | utf8 | |
1994+
/// | db_schema_tables | list<TABLE_SCHEMA> | |
1995+
/// | remarks | utf8 | (1) |
1996+
///
1997+
/// 1. [Since version 1.2.0] A description of the schema. This field is
1998+
/// optional.
19911999
///
19922000
/// TABLE_SCHEMA is a Struct with fields:
19932001
///
@@ -1998,9 +2006,12 @@ AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection,
19982006
/// | table_columns | list<COLUMN_SCHEMA> | |
19992007
/// | table_constraints | list<CONSTRAINT_SCHEMA> | |
20002008
/// | table_definition | utf8 | (1) |
2009+
/// | remarks | utf8 | (2) |
20012010
///
20022011
/// 1. [Since version 1.2.0] The table or view definition (e.g. a SQL DDL
20032012
/// statement). This field is optional.
2013+
/// 2. [Since version 1.2.0] A description of the table. This field is
2014+
/// optional.
20042015
///
20052016
/// COLUMN_SCHEMA is a Struct with fields:
20062017
///
@@ -2025,12 +2036,14 @@ AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection,
20252036
/// | xdbc_scope_table | utf8 | (3) |
20262037
/// | xdbc_is_autoincrement | bool | (3) |
20272038
/// | xdbc_is_generatedcolumn | bool | (3) |
2039+
/// | xdbc_source_data_type | int16 | (3, 4) |
20282040
///
20292041
/// 1. The column's ordinal position in the table (starting from 1).
20302042
/// 2. Database-specific description of the column.
20312043
/// 3. Optional value. Should be null if not supported by the driver.
20322044
/// xdbc_ values are meant to provide JDBC/ODBC-compatible metadata
20332045
/// in an agnostic manner.
2046+
/// 4. [Since version 1.2.0] This field is optional.
20342047
///
20352048
/// CONSTRAINT_SCHEMA is a Struct with fields:
20362049
///
@@ -2093,6 +2106,13 @@ AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection,
20932106
/// values may still be null if the driver does not actually support that
20942107
/// field).
20952108
///
2109+
/// Starting in version 1.2.0, driver-specific fields were introduced to the
2110+
/// schema. Drivers may add custom fields at the end of any schema above to
2111+
/// reflect vendor-specific metadata. Applications must access these using an
2112+
/// offset from the end of the schema and cannot assume that the index of the
2113+
/// field will remain stable. Drivers should prefix field names with the
2114+
/// vendor/driver name to differentiate them (e.g. 'POSTGRESQL:owner').
2115+
///
20962116
/// This AdbcConnection must outlive the returned ArrowArrayStream.
20972117
///
20982118
/// \param[in] connection The database connection.

0 commit comments

Comments
 (0)