Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions c/include/arrow-adbc/adbc.h
Original file line number Diff line number Diff line change
Expand Up @@ -1268,6 +1268,10 @@ AdbcStatusCode AdbcMultiResultSetRelease(struct AdbcMultiResultSet* result_set,
/// has been reached; it should simply continue to return ADBC_STATUS_OK with a
/// NULL release callback.
///
/// Drivers may annotate the result schema columns with the underlying
/// system's name for the data type by adding field metadata. See
/// AdbcConnectionGetTableSchema.
///
/// \param[in] result_set The result set struct to fetch the next result from.
/// \param[out] out The result stream to populate
/// \param[out] rows_affected The number of rows affected if known, else -
Expand Down Expand Up @@ -1297,6 +1301,10 @@ AdbcStatusCode AdbcMultiResultSetNext(struct AdbcMultiResultSet* result_set,
/// result set has been reached; it should simply continue to return ADBC_STATUS_OK with
/// a NULL release callback.
///
/// Drivers may annotate the result schema columns with the underlying
/// system's name for the data type by adding field metadata. See
/// AdbcConnectionGetTableSchema.
///
/// \param[in] result_set The result set struct to fetch the next result from.
/// \param[out] schema The schema of the result set to populate
/// \param[out] partitions The partitions to populate
Expand Down Expand Up @@ -2330,6 +2338,10 @@ AdbcStatusCode AdbcConnectionGetStatisticNames(struct AdbcConnection* connection

/// \brief Get the Arrow schema of a table.
///
/// Drivers may annotate the result schema columns with the underlying
/// system's name for the data type by adding field metadata. The name of the
/// metadata key should be `<VENDOR>:type` (e.g. `POSTGRESQL:type`).
///
/// \param[in] connection The database connection.
/// \param[in] catalog The catalog (or nullptr if not applicable).
/// \param[in] db_schema The database schema (or nullptr if not applicable).
Expand Down Expand Up @@ -2458,6 +2470,10 @@ AdbcStatusCode AdbcStatementRelease(struct AdbcStatement* statement,
/// Since ADBC 1.1.0: releasing the returned ArrowArrayStream without
/// consuming it fully is equivalent to calling AdbcStatementCancel.
///
/// Drivers may annotate the result schema columns with the underlying
/// system's name for the data type by adding field metadata. See
/// AdbcConnectionGetTableSchema.
///
/// \param[in] statement The statement to execute.
/// \param[out] out The results. Pass NULL if the client does not
/// expect a result set.
Expand Down Expand Up @@ -2490,6 +2506,10 @@ AdbcStatusCode AdbcStatementExecuteQuery(struct AdbcStatement* statement,
/// of all result sets before consuming any data, which can be useful for certain
/// applications such as query planning or UI display of results.
///
/// Drivers may annotate the result schema columns with the underlying
/// system's name for the data type by adding field metadata. See
/// AdbcConnectionGetTableSchema.
///
/// \param[in] statement The statement to execute.
/// \param[out] results The result set struct to populate with the schemas of the result
/// sets.
Expand Down Expand Up @@ -2544,6 +2564,10 @@ AdbcStatusCode AdbcStatementExecuteMulti(struct AdbcStatement* statement,
/// Depending on the driver, this may require first executing
/// AdbcStatementPrepare.
///
/// Drivers may annotate the result schema columns with the underlying
/// system's name for the data type by adding field metadata. See
/// AdbcConnectionGetTableSchema.
///
/// \since ADBC API revision 1.1.0
///
/// \param[in] statement The statement to execute.
Expand Down Expand Up @@ -2870,6 +2894,10 @@ AdbcStatusCode AdbcStatementSetOptionDouble(struct AdbcStatement* statement,
/// \brief Execute a statement and get the results as a partitioned
/// result set.
///
/// Drivers may annotate the result schema columns with the underlying
/// system's name for the data type by adding field metadata. See
/// AdbcConnectionGetTableSchema.
///
/// \param[in] statement The statement to execute.
/// \param[out] schema The schema of the result set.
/// \param[out] partitions The result partitions.
Expand Down
28 changes: 28 additions & 0 deletions go/adbc/drivermgr/arrow-adbc/adbc.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading