Skip to content

feat(format): add table_definition to GetObjects #4050

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lidavidm wants to merge 2 commits into
base: spec-1.2.0
Choose a base branch
from
Open

feat(format): add table_definition to GetObjects #4050

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8d1ce8
feat(format): add table_definition to GetObjects
lidavidm Mar 5, 2026
81d6d1e
add more
lidavidm Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 38 additions & 14 deletions c/include/arrow-adbc/adbc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1977,26 +1977,41 @@ AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection,
///
/// The result is an Arrow dataset with the following schema:
///
/// | Field Name | Field Type |
/// |--------------------------|-------------------------|
/// | catalog_name | utf8 |
/// | catalog_db_schemas | list<DB_SCHEMA_SCHEMA> |
/// | Field Name | Field Type | Comments |
/// |--------------------------|-------------------------|----------|
/// | catalog_name | utf8 | |
/// | catalog_db_schemas | list<DB_SCHEMA_SCHEMA> | |
/// | remarks | utf8 | (1) |
///
/// 1. [Since version 1.2.0] A description of the catalog. This field is
/// optional.
///
/// DB_SCHEMA_SCHEMA is a Struct with fields:
///
/// | Field Name | Field Type |
/// |--------------------------|-------------------------|
/// | db_schema_name | utf8 |
/// | db_schema_tables | list<TABLE_SCHEMA> |
/// | Field Name | Field Type | Comments |
/// |--------------------------|-------------------------|----------|
/// | db_schema_name | utf8 | |
/// | db_schema_tables | list<TABLE_SCHEMA> | |
/// | remarks | utf8 | (1) |
///
/// 1. [Since version 1.2.0] A description of the schema. This field is
/// optional.
///
/// TABLE_SCHEMA is a Struct with fields:
///
/// | Field Name | Field Type |
/// |--------------------------|-------------------------|
/// | table_name | utf8 not null |
/// | table_type | utf8 not null |
/// | table_columns | list<COLUMN_SCHEMA> |
/// | table_constraints | list<CONSTRAINT_SCHEMA> |
/// | Field Name | Field Type | Comments |
/// |--------------------------|-------------------------|----------|
/// | table_name | utf8 not null | |
/// | table_type | utf8 not null | |
/// | table_columns | list<COLUMN_SCHEMA> | |
/// | table_constraints | list<CONSTRAINT_SCHEMA> | |
/// | table_definition | utf8 | (1) |
/// | remarks | utf8 | (2) |
///
Comment on lines +2008 to +2010
Copy link
Member

@paleolimbot paleolimbot Mar 11, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We had chatted in the previous issue about adding a serialized Arrow schema here. I don't love the idea of putting Arrow IPC stuffed in a deeply nested Arrow C Array but I'm also in a very small minority of people who is aware of or cares how many lines of code are required to parse it 🙂 . If you'd like to add it it does seem like a good opportunity to do so.

/// 1. [Since version 1.2.0] The table or view definition (e.g. a SQL DDL
/// statement). This field is optional.
/// 2. [Since version 1.2.0] A description of the table. This field is
/// optional.
///
/// COLUMN_SCHEMA is a Struct with fields:
///
Expand All @@ -2021,12 +2036,14 @@ AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection,
/// | xdbc_scope_table | utf8 | (3) |
/// | xdbc_is_autoincrement | bool | (3) |
/// | xdbc_is_generatedcolumn | bool | (3) |
/// | xdbc_source_data_type | int16 | (3, 4) |
///
/// 1. The column's ordinal position in the table (starting from 1).
/// 2. Database-specific description of the column.
/// 3. Optional value. Should be null if not supported by the driver.
/// xdbc_ values are meant to provide JDBC/ODBC-compatible metadata
/// in an agnostic manner.
/// 4. [Since version 1.2.0] This field is optional.
///
/// CONSTRAINT_SCHEMA is a Struct with fields:
///
Expand Down Expand Up @@ -2089,6 +2106,13 @@ AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection,
/// values may still be null if the driver does not actually support that
/// field).
///
/// Starting in version 1.2.0, driver-specific fields were introduced to the
/// schema. Drivers may add custom fields at the end of any schema above to
/// reflect vendor-specific metadata. Applications must access these using an
/// offset from the end of the schema and cannot assume that the index of the
/// field will remain stable. Drivers should prefix field names with the
/// vendor/driver name to differentiate them (e.g. 'POSTGRESQL:owner').
///
/// This AdbcConnection must outlive the returned ArrowArrayStream.
///
/// \param[in] connection The database connection.
Expand Down
Loading