-
Notifications
You must be signed in to change notification settings - Fork 194
feat(c/include/arrow-adbc): Add AdbcStatementRequestSchema #3623
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.
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
base: spec-1.2.0
Are you sure you want to change the base?
Changes from 4 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1255,6 +1255,10 @@ struct ADBC_EXPORT AdbcDriver { | |
| AdbcStatusCode (*StatementSetOptionInt)(struct AdbcStatement*, const char*, int64_t, | ||
| struct AdbcError*); | ||
|
|
||
| // ADBC 1.2 | ||
| AdbcStatusCode (*StatementRequestSchema)(struct AdbcStatement*, struct ArrowSchema*, | ||
| struct AdbcError*); | ||
|
|
||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There's already a block for 1.2.0 below |
||
| /// @} | ||
|
|
||
| /// \defgroup adbc-1.2.0 ADBC API Revision 1.2.0 | ||
|
|
@@ -2293,6 +2297,36 @@ AdbcStatusCode AdbcStatementExecuteSchema(struct AdbcStatement* statement, | |
| struct ArrowSchema* schema, | ||
| struct AdbcError* error); | ||
|
|
||
| /// \brief Request the schema of the next statement execution | ||
| /// | ||
| /// Allows the caller to request a specific schema based on prior | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we explicitly define the behavior if columns in the result schema are missing from the requested schema and the reverse (columns in the requested schema missing from the result schema)? What about column ordering? I'm not making any suggestions about what the behavior should be, just that we should explicitly state what the expected behavior should be in those cases.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good point...I will try to update the text tonight. Off the top of my head the ability to request a schema with more columns than the source or in a different order is useful, as is widening the allowed nullability. Requesting fewer columns is fishy. DataFusion has quite a nice programmatic definition of this (designed for casting struct columns to match each other, possibly from multiple Parquet files). |
||
| /// information or user input. This may be used to ensure a | ||
| /// consistent schema when executing queries against a database | ||
| /// with row-based types (e.g., SQLite) or a database whose types | ||
| /// are implemented with row-based parameters where Arrow prefers | ||
| /// type-level parameters (e.g., NUMERIC for PostgreSQL). | ||
| /// | ||
| /// The provided schema is a request and not a guarantee (i.e., | ||
| /// callers must use the schema provided by the output stream to | ||
| /// interpret the result). | ||
| /// | ||
| /// Calling AdbcStatementRequestSchema() must not affect the result | ||
| /// of AdbcStatementExecuteSchema (which always infers its result | ||
| /// from the input query). | ||
| /// | ||
| /// \since ADBC API revision 1.2.0 | ||
| /// | ||
| /// \param[in] statement The statement to execute. | ||
| /// \param[in] schema The requested schema. | ||
| /// \param[out] error An optional location to return an error | ||
| /// message if necessary. | ||
| /// | ||
| /// \return ADBC_STATUS_NOT_IMPLEMENTED if the driver does not support this. | ||
| ADBC_EXPORT | ||
| AdbcStatusCode AdbcStatementRequestSchema(struct AdbcStatement* statement, | ||
| struct ArrowSchema* schema, | ||
| struct AdbcError* error); | ||
|
|
||
| /// \brief Turn this statement into a prepared statement to be | ||
| /// executed multiple times. | ||
| /// | ||
|
|
||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs to be in a separate block that checks the version