This is an automated email from the ASF dual-hosted git repository. github-bot pushed a commit to branch asf-site in repository https://gitbox.apache.org/repos/asf/arrow-adbc.git
The following commit(s) were added to refs/heads/asf-site by this push: new 16250e0e publish documentation 16250e0e is described below commit 16250e0e2416cd4505100b0601f5ea9b8f92a65f Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com> AuthorDate: Mon Jun 19 16:43:12 2023 +0000 publish documentation --- main/cpp/api/adbc.html | 1099 +-------------------------------- main/cpp/api/adbc_driver_manager.html | 8 +- main/cpp/concurrency.html | 2 +- main/cpp/driver_manager.html | 2 +- main/cpp/quickstart.html | 2 +- main/driver/flight_sql.html | 4 +- main/driver/snowflake.html | 2 +- main/driver/status.html | 4 +- main/format/specification.html | 6 +- main/format/versioning.html | 4 +- main/genindex.html | 150 +---- main/objects.inv | Bin 7485 -> 4378 bytes main/python/driver_manager.html | 2 +- main/searchindex.js | 2 +- 14 files changed, 49 insertions(+), 1238 deletions(-) diff --git a/main/cpp/api/adbc.html b/main/cpp/api/adbc.html index 4ae1e7b8..9908eff8 100644 --- a/main/cpp/api/adbc.html +++ b/main/cpp/api/adbc.html @@ -338,1051 +338,6 @@ <span class="target" id="adbc_8h_1a52c43fe881800162290764f1e683c9fa"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC</span></span></span><a class="headerlink" href="#c.ADBC" title="Permalink to this definition">#</a><br /></dt> <dd></dd></dl> -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_OK"> -<span class="target" id="group__adbc-error-handling_1gabc137e5935d54d1be2bc2e07b70752b1"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_OK</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_OK" title="Permalink to this definition">#</a><br /></dt> -<dd><p>No error. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_UNKNOWN"> -<span class="target" id="group__adbc-error-handling_1ga7304ac590fc54192dadd6758575b00bd"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_UNKNOWN</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_UNKNOWN" title="Permalink to this definition">#</a><br /></dt> -<dd><p>An unknown error occurred. </p> -<p>May indicate a driver-side or database-side error. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_NOT_IMPLEMENTED"> -<span class="target" id="group__adbc-error-handling_1ga40ffb7cc27dff6335756c56fa4094a1d"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_NOT_IMPLEMENTED</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_NOT_IMPLEMENTED" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The operation is not implemented or supported. </p> -<p>May indicate a driver-side or database-side error. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_NOT_FOUND"> -<span class="target" id="group__adbc-error-handling_1ga88649145d5ef83eba2eb69d22bb9a2e3"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_NOT_FOUND</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_NOT_FOUND" title="Permalink to this definition">#</a><br /></dt> -<dd><p>A requested resource was not found. </p> -<p>May indicate a driver-side or database-side error. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_ALREADY_EXISTS"> -<span class="target" id="group__adbc-error-handling_1ga88f6a9243d510ab672ce9fa48b1aa324"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_ALREADY_EXISTS</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_ALREADY_EXISTS" title="Permalink to this definition">#</a><br /></dt> -<dd><p>A requested resource already exists. </p> -<p>May indicate a driver-side or database-side error. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_INVALID_ARGUMENT"> -<span class="target" id="group__adbc-error-handling_1gac36eeb700db45827954182ced4c23595"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_INVALID_ARGUMENT</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_INVALID_ARGUMENT" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The arguments are invalid, likely a programming error. </p> -<p>For instance, they may be of the wrong format, or out of range.</p> -<p>May indicate a driver-side or database-side error. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_INVALID_STATE"> -<span class="target" id="group__adbc-error-handling_1gac3ce1a13696ab0a58455a2c277587571"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_INVALID_STATE</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_INVALID_STATE" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The preconditions for the operation are not met, likely a programming error. </p> -<p>For instance, the object may be uninitialized, or may have not been fully configured.</p> -<p>May indicate a driver-side or database-side error. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_INVALID_DATA"> -<span class="target" id="group__adbc-error-handling_1ga4c63864b24e49b95a00d3fa680e26ced"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_INVALID_DATA</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_INVALID_DATA" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Invalid data was processed (not a programming error). </p> -<p>For instance, a division by zero may have occurred during query execution.</p> -<p>May indicate a database-side error only. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_INTEGRITY"> -<span class="target" id="group__adbc-error-handling_1ga83da2be9fdafa1e21af0b778643e8c59"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_INTEGRITY</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_INTEGRITY" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The database’s integrity was affected. </p> -<p>For instance, a foreign key check may have failed, or a uniqueness constraint may have been violated.</p> -<p>May indicate a database-side error only. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_INTERNAL"> -<span class="target" id="group__adbc-error-handling_1gae4291ac8711735f404d59da024c6b62a"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_INTERNAL</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_INTERNAL" title="Permalink to this definition">#</a><br /></dt> -<dd><p>An error internal to the driver or database occurred. </p> -<p>May indicate a driver-side or database-side error. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_IO"> -<span class="target" id="group__adbc-error-handling_1ga4ab064dacfe809a24ec7afcb709c2ad7"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_IO</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_IO" title="Permalink to this definition">#</a><br /></dt> -<dd><p>An I/O error occurred. </p> -<p>For instance, a remote service may be unavailable.</p> -<p>May indicate a driver-side or database-side error. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_CANCELLED"> -<span class="target" id="group__adbc-error-handling_1gaea6b6bfffb708bba55ee19a475f0d257"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_CANCELLED</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_CANCELLED" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The operation was cancelled, not due to a timeout. </p> -<p>May indicate a driver-side or database-side error. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_TIMEOUT"> -<span class="target" id="group__adbc-error-handling_1gaf08c8582d5ebbda6e484ee60337884e2"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_TIMEOUT</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_TIMEOUT" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The operation was cancelled due to a timeout. </p> -<p>May indicate a driver-side or database-side error. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_UNAUTHENTICATED"> -<span class="target" id="group__adbc-error-handling_1ga7d5af2733d24382f811a44de1a6d85dc"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_UNAUTHENTICATED</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_UNAUTHENTICATED" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Authentication failed. </p> -<p>May indicate a database-side error only. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_STATUS_UNAUTHORIZED"> -<span class="target" id="group__adbc-error-handling_1ga4b9a5ee125e1c747213bf571bd36d852"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_STATUS_UNAUTHORIZED</span></span></span><a class="headerlink" href="#c.ADBC_STATUS_UNAUTHORIZED" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The client is not authorized to perform the given operation. </p> -<p>May indicate a database-side error only. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_VERSION_1_0_0"> -<span class="target" id="group__adbc-constants_1ga17b4d4cc14a0c200090c0182edf34ba7"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_VERSION_1_0_0</span></span></span><a class="headerlink" href="#c.ADBC_VERSION_1_0_0" title="Permalink to this definition">#</a><br /></dt> -<dd><p>ADBC revision 1.0.0. </p> -<p>When passed to an <a class="reference internal" href="#group__adbc-driver_1ga5fb0507a84a8d440448d1c6b5cb0d1db"><span class="std std-ref">AdbcDriverInitFunc()</span></a>, the driver parameter must point to an <a class="reference internal" href="#structAdbcDriver"><span class="std std-ref">AdbcDriver</span></a>. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OPTION_VALUE_ENABLED"> -<span class="target" id="group__adbc-constants_1gabd9527bda5f62ad8a64b23e1a6d1cad4"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OPTION_VALUE_ENABLED</span></span></span><a class="headerlink" href="#c.ADBC_OPTION_VALUE_ENABLED" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Canonical option value for enabling an option. </p> -<p>For use as the value in SetOption calls. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OPTION_VALUE_DISABLED"> -<span class="target" id="group__adbc-constants_1gaa1bb3198d60fcb8c1d22e31834fba6ca"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OPTION_VALUE_DISABLED</span></span></span><a class="headerlink" href="#c.ADBC_OPTION_VALUE_DISABLED" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Canonical option value for disabling an option. </p> -<p>For use as the value in SetOption calls. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_INFO_VENDOR_NAME"> -<span class="target" id="group__adbc-constants_1ga334295c2bab204351502587698f12a2d"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_INFO_VENDOR_NAME</span></span></span><a class="headerlink" href="#c.ADBC_INFO_VENDOR_NAME" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The database vendor/product name (e.g. the server name). (type: utf8). </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection-metadata_1ga72f6253a8bee78ad201f30ceb1ef3f4c"><span class="std std-ref">AdbcConnectionGetInfo</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_INFO_VENDOR_VERSION"> -<span class="target" id="group__adbc-constants_1gac068e3b889e54d1ee7123445de4a5808"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_INFO_VENDOR_VERSION</span></span></span><a class="headerlink" href="#c.ADBC_INFO_VENDOR_VERSION" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The database vendor/product version (type: utf8). </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection-metadata_1ga72f6253a8bee78ad201f30ceb1ef3f4c"><span class="std std-ref">AdbcConnectionGetInfo</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_INFO_VENDOR_ARROW_VERSION"> -<span class="target" id="group__adbc-constants_1ga78346a6dfd63c7cf3047eab1b6527512"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_INFO_VENDOR_ARROW_VERSION</span></span></span><a class="headerlink" href="#c.ADBC_INFO_VENDOR_ARROW_VERSION" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The database vendor/product Arrow library version (type: utf8). </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection-metadata_1ga72f6253a8bee78ad201f30ceb1ef3f4c"><span class="std std-ref">AdbcConnectionGetInfo</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_INFO_DRIVER_NAME"> -<span class="target" id="group__adbc-constants_1ga0faf91aa6b77d9294e6cd81916101a84"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_INFO_DRIVER_NAME</span></span></span><a class="headerlink" href="#c.ADBC_INFO_DRIVER_NAME" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The driver name (type: utf8). </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection-metadata_1ga72f6253a8bee78ad201f30ceb1ef3f4c"><span class="std std-ref">AdbcConnectionGetInfo</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_INFO_DRIVER_VERSION"> -<span class="target" id="group__adbc-constants_1ga8e446bae19b88e468cd98edb6bbd3d39"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_INFO_DRIVER_VERSION</span></span></span><a class="headerlink" href="#c.ADBC_INFO_DRIVER_VERSION" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The driver version (type: utf8). </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection-metadata_1ga72f6253a8bee78ad201f30ceb1ef3f4c"><span class="std std-ref">AdbcConnectionGetInfo</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_INFO_DRIVER_ARROW_VERSION"> -<span class="target" id="group__adbc-constants_1ga4c3522556a02af806540e8c67607618e"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_INFO_DRIVER_ARROW_VERSION</span></span></span><a class="headerlink" href="#c.ADBC_INFO_DRIVER_ARROW_VERSION" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The driver Arrow library version (type: utf8). </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection-metadata_1ga72f6253a8bee78ad201f30ceb1ef3f4c"><span class="std std-ref">AdbcConnectionGetInfo</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OBJECT_DEPTH_ALL"> -<span class="target" id="group__adbc-constants_1gab12f4e84db57c8c793ba59cfe7c4feff"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OBJECT_DEPTH_ALL</span></span></span><a class="headerlink" href="#c.ADBC_OBJECT_DEPTH_ALL" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Return metadata on catalogs, schemas, tables, and columns. </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection-metadata_1ga32f64f4cfc86140e2d8d02b328215dbf"><span class="std std-ref">AdbcConnectionGetObjects</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OBJECT_DEPTH_CATALOGS"> -<span class="target" id="group__adbc-constants_1ga4671a35bdbf53cd9736cf60e80f5948c"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OBJECT_DEPTH_CATALOGS</span></span></span><a class="headerlink" href="#c.ADBC_OBJECT_DEPTH_CATALOGS" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Return metadata on catalogs only. </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection-metadata_1ga32f64f4cfc86140e2d8d02b328215dbf"><span class="std std-ref">AdbcConnectionGetObjects</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OBJECT_DEPTH_DB_SCHEMAS"> -<span class="target" id="group__adbc-constants_1ga8bf6501439308e86a1f4d43a49e3172e"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OBJECT_DEPTH_DB_SCHEMAS</span></span></span><a class="headerlink" href="#c.ADBC_OBJECT_DEPTH_DB_SCHEMAS" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Return metadata on catalogs and schemas. </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection-metadata_1ga32f64f4cfc86140e2d8d02b328215dbf"><span class="std std-ref">AdbcConnectionGetObjects</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OBJECT_DEPTH_TABLES"> -<span class="target" id="group__adbc-constants_1ga0ad2d0e1e0c7bd7087e73c0834a54e78"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OBJECT_DEPTH_TABLES</span></span></span><a class="headerlink" href="#c.ADBC_OBJECT_DEPTH_TABLES" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Return metadata on catalogs, schemas, and tables. </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection-metadata_1ga32f64f4cfc86140e2d8d02b328215dbf"><span class="std std-ref">AdbcConnectionGetObjects</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OBJECT_DEPTH_COLUMNS"> -<span class="target" id="group__adbc-constants_1gad19dbe78fddc3299360c82e7e2e1a744"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OBJECT_DEPTH_COLUMNS</span></span></span><a class="headerlink" href="#c.ADBC_OBJECT_DEPTH_COLUMNS" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Return metadata on catalogs, schemas, tables, and columns. </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection-metadata_1ga32f64f4cfc86140e2d8d02b328215dbf"><span class="std std-ref">AdbcConnectionGetObjects</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_CONNECTION_OPTION_AUTOCOMMIT"> -<span class="target" id="group__adbc-constants_1ga67c5f2a5de514d4126b23fa7497ab9d4"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_CONNECTION_OPTION_AUTOCOMMIT</span></span></span><a class="headerlink" href="#c.ADBC_CONNECTION_OPTION_AUTOCOMMIT" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The name of the canonical option for whether autocommit is enabled. </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection_1ga05138fc1a1b6c90c705d22bcc9249d03"><span class="std std-ref">AdbcConnectionSetOption</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_CONNECTION_OPTION_READ_ONLY"> -<span class="target" id="group__adbc-constants_1gafa1a50cb8e97bb97a84e2c7322aa7fa9"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_CONNECTION_OPTION_READ_ONLY</span></span></span><a class="headerlink" href="#c.ADBC_CONNECTION_OPTION_READ_ONLY" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The name of the canonical option for whether the current connection should be restricted to being read-only. </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection_1ga05138fc1a1b6c90c705d22bcc9249d03"><span class="std std-ref">AdbcConnectionSetOption</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_CONNECTION_OPTION_ISOLATION_LEVEL"> -<span class="target" id="group__adbc-constants_1gabfd8f71d27528c928d18fef6437305bb"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_CONNECTION_OPTION_ISOLATION_LEVEL</span></span></span><a class="headerlink" href="#c.ADBC_CONNECTION_OPTION_ISOLATION_LEVEL" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The name of the canonical option for setting the isolation level of a transaction. </p> -<p>Should only be used in conjunction with autocommit disabled and AdbcConnectionCommit / AdbcConnectionRollback. If the desired isolation level is not supported by a driver, it should return an appropriate error.</p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection_1ga05138fc1a1b6c90c705d22bcc9249d03"><span class="std std-ref">AdbcConnectionSetOption</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OPTION_ISOLATION_LEVEL_DEFAULT"> -<span class="target" id="group__adbc-constants_1ga5fdca57bce7d7acb146018ac5324843e"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OPTION_ISOLATION_LEVEL_DEFAULT</span></span></span><a class="headerlink" href="#c.ADBC_OPTION_ISOLATION_LEVEL_DEFAULT" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Use database or driver default isolation level. </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection_1ga05138fc1a1b6c90c705d22bcc9249d03"><span class="std std-ref">AdbcConnectionSetOption</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OPTION_ISOLATION_LEVEL_READ_UNCOMMITTED"> -<span class="target" id="group__adbc-constants_1ga244fec47004afefd01c88dd860370b53"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OPTION_ISOLATION_LEVEL_READ_UNCOMMITTED</span></span></span><a class="headerlink" href="#c.ADBC_OPTION_ISOLATION_LEVEL_READ_UNCOMMITTED" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The lowest isolation level. Dirty reads are allowed, so one transaction may see not-yet-committed changes made by others. </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection_1ga05138fc1a1b6c90c705d22bcc9249d03"><span class="std std-ref">AdbcConnectionSetOption</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OPTION_ISOLATION_LEVEL_READ_COMMITTED"> -<span class="target" id="group__adbc-constants_1ga2fce94174222c74930f5248e1df0d656"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OPTION_ISOLATION_LEVEL_READ_COMMITTED</span></span></span><a class="headerlink" href="#c.ADBC_OPTION_ISOLATION_LEVEL_READ_COMMITTED" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Lock-based concurrency control keeps write locks until the end of the transaction, but read locks are released as soon as a SELECT is performed. Non-repeatable reads can occur in this isolation level. </p> -<p>More simply put, Read Committed is an isolation level that guarantees that any data read is committed at the moment it is read. It simply restricts the reader from seeing any intermediate, uncommitted, ‘dirty’ reads. It makes no promise whatsoever that if the transaction re-issues the read, it will find the same data; data is free to change after it is read.</p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection_1ga05138fc1a1b6c90c705d22bcc9249d03"><span class="std std-ref">AdbcConnectionSetOption</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OPTION_ISOLATION_LEVEL_REPEATABLE_READ"> -<span class="target" id="group__adbc-constants_1ga10b519e2e06d1adef1d57146845778d8"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OPTION_ISOLATION_LEVEL_REPEATABLE_READ</span></span></span><a class="headerlink" href="#c.ADBC_OPTION_ISOLATION_LEVEL_REPEATABLE_READ" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Lock-based concurrency control keeps read AND write locks (acquired on selection data) until the end of the transaction. </p> -<p>However, range-locks are not managed, so phantom reads can occur. Write skew is possible at this isolation level in some systems.</p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection_1ga05138fc1a1b6c90c705d22bcc9249d03"><span class="std std-ref">AdbcConnectionSetOption</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OPTION_ISOLATION_LEVEL_SNAPSHOT"> -<span class="target" id="group__adbc-constants_1ga79b5eb55f40eb1cb0a4bbe6bb16e1895"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OPTION_ISOLATION_LEVEL_SNAPSHOT</span></span></span><a class="headerlink" href="#c.ADBC_OPTION_ISOLATION_LEVEL_SNAPSHOT" title="Permalink to this definition">#</a><br /></dt> -<dd><p>This isolation guarantees that all reads in the transaction will see a consistent snapshot of the database and the transaction should only successfully commit if no updates conflict with any concurrent updates made since that snapshot. </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection_1ga05138fc1a1b6c90c705d22bcc9249d03"><span class="std std-ref">AdbcConnectionSetOption</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OPTION_ISOLATION_LEVEL_SERIALIZABLE"> -<span class="target" id="group__adbc-constants_1gac71c7e819282c0c2d371a9714da60b87"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OPTION_ISOLATION_LEVEL_SERIALIZABLE</span></span></span><a class="headerlink" href="#c.ADBC_OPTION_ISOLATION_LEVEL_SERIALIZABLE" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Serializability requires read and write locks to be released only at the end of the transaction. This includes acquiring range- locks when a select query uses a ranged WHERE clause to avoid phantom reads. </p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection_1ga05138fc1a1b6c90c705d22bcc9249d03"><span class="std std-ref">AdbcConnectionSetOption</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_OPTION_ISOLATION_LEVEL_LINEARIZABLE"> -<span class="target" id="group__adbc-constants_1ga176eaab1f1229ab5341a0591eb54f1f5"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_OPTION_ISOLATION_LEVEL_LINEARIZABLE</span></span></span><a class="headerlink" href="#c.ADBC_OPTION_ISOLATION_LEVEL_LINEARIZABLE" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The central distinction between serializability and linearizability is that serializability is a global property; a property of an entire history of operations and transactions. Linearizability is a local property; a property of a single operation/transaction. </p> -<p>Linearizability can be viewed as a special case of strict serializability where transactions are restricted to consist of a single operation applied to a single object.</p> -<p><div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p><a class="reference internal" href="#group__adbc-connection_1ga05138fc1a1b6c90c705d22bcc9249d03"><span class="std std-ref">AdbcConnectionSetOption</span></a></p> -</div> -</p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_INGEST_OPTION_TARGET_TABLE"> -<span class="target" id="group__adbc-statement-ingestion_1gad325f2e1b05672d5986bff954daf1f5a"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_INGEST_OPTION_TARGET_TABLE</span></span></span><a class="headerlink" href="#c.ADBC_INGEST_OPTION_TARGET_TABLE" title="Permalink to this definition">#</a><br /></dt> -<dd><p>The name of the target table for a bulk insert. </p> -<p>The driver should attempt to create the table if it does not exist. If the table exists but has a different schema, ADBC_STATUS_ALREADY_EXISTS should be raised. Else, data should be appended to the target table. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_INGEST_OPTION_MODE"> -<span class="target" id="group__adbc-statement-ingestion_1ga95b773429bee5ef212e86737d1e900f8"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_INGEST_OPTION_MODE</span></span></span><a class="headerlink" href="#c.ADBC_INGEST_OPTION_MODE" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Whether to create (the default) or append. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_INGEST_OPTION_MODE_CREATE"> -<span class="target" id="group__adbc-statement-ingestion_1ga04ce99899a716a3266689dcc8cacb26f"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_INGEST_OPTION_MODE_CREATE</span></span></span><a class="headerlink" href="#c.ADBC_INGEST_OPTION_MODE_CREATE" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Create the table and insert data; error if the table exists. </p> -</dd></dl> - -<dl class="cpp macro"> -<dt class="sig sig-object cpp" id="c.ADBC_INGEST_OPTION_MODE_APPEND"> -<span class="target" id="group__adbc-statement-ingestion_1gacdea739b09b481633ea40683d67cc755"></span><span class="sig-name descname"><span class="n"><span class="pre">ADBC_INGEST_OPTION_MODE_APPEND</span></span></span><a class="headerlink" href="#c.ADBC_INGEST_OPTION_MODE_APPEND" title="Permalink to this definition">#</a><br /></dt> -<dd><p>Do not create the table, and insert data; error if the table does not exist (ADBC_STATUS_NOT_FOUND) or does not match the schema of the data to append (ADBC_STATUS_ALREADY_EXISTS). </p> -</dd></dl> - -</div> -<div class="breathe-sectiondef docutils container"> -<p class="breathe-sectiondef-title rubric" id="breathe-section-title-typedefs">Typedefs</p> -<dl class="cpp type"> -<dt class="sig sig-object cpp" id="_CPPv414AdbcStatusCode"> -<span id="_CPPv314AdbcStatusCode"></span><span id="_CPPv214AdbcStatusCode"></span><span id="AdbcStatusCode"></span><span class="target" id="group__adbc-error-handling_1ga6af034a7846314de57fe1b14f8ad2754"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AdbcStatusCode</span></span></span><a class="headerlink" [...] -<dd><p>Error codes for operations that may fail. </p> -</dd></dl> - -<dl class="cpp type"> -<dt class="sig sig-object cpp" id="_CPPv418AdbcDriverInitFunc"> -<span id="_CPPv318AdbcDriverInitFunc"></span><span id="_CPPv218AdbcDriverInitFunc"></span><span id="AdbcDriverInitFunc"></span><span class="target" id="group__adbc-driver_1ga5fb0507a84a8d440448d1c6b5cb0d1db"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span cl [...] -<dd><p>Common entry point for drivers via the driver manager (which uses dlopen(3)/LoadLibrary). The driver manager is told to load a library and call a function of this type to load the driver. </p> -<p>Although drivers may choose any name for this function, the recommended name is “AdbcDriverInit”.</p> -<dl class="field-list simple"> -<dt class="field-odd">Param version<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>[in]</strong> The ADBC revision to attempt to initialize (see ADBC_VERSION_1_0_0). </p> -</dd> -<dt class="field-even">Param driver<span class="colon">:</span></dt> -<dd class="field-even"><p><strong>[out]</strong> The table of function pointers to initialize. Should be a pointer to the appropriate struct for the given version (see the documentation for the version). </p> -</dd> -<dt class="field-odd">Param error<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>[out]</strong> An optional location to return an error message if necessary. </p> -</dd> -<dt class="field-even">Return<span class="colon">:</span></dt> -<dd class="field-even"><p>ADBC_STATUS_OK if the driver was initialized, or ADBC_STATUS_NOT_IMPLEMENTED if the version is not supported. In that case, clients may retry with a different version. </p> -</dd> -</dl> -</dd></dl> - -</div> -<div class="breathe-sectiondef docutils container"> -<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p> -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv415AdbcDatabaseNewP12AdbcDatabaseP9AdbcError"> -<span id="_CPPv315AdbcDatabaseNewP12AdbcDatabaseP9AdbcError"></span><span id="_CPPv215AdbcDatabaseNewP12AdbcDatabaseP9AdbcError"></span><span id="AdbcDatabaseNew__AdbcDatabaseP.AdbcErrorP"></span><span class="target" id="group__adbc-database_1ga44a8eb11b99c063c46d698912556c74c"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="sig-name descname"> [...] -<dd><p>Allocate a new (but uninitialized) database. </p> -<p>Callers pass in a zero-initialized <a class="reference internal" href="#structAdbcDatabase"><span class="std std-ref">AdbcDatabase</span></a>.</p> -<p>Drivers should allocate their internal data structure and set the private_data field to point to the newly allocated struct. This struct should be released when AdbcDatabaseRelease is called. </p> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv421AdbcDatabaseSetOptionP12AdbcDatabasePKcPKcP9AdbcError"> -<span id="_CPPv321AdbcDatabaseSetOptionP12AdbcDatabasePKcPKcP9AdbcError"></span><span id="_CPPv221AdbcDatabaseSetOptionP12AdbcDatabasePKcPKcP9AdbcError"></span><span id="AdbcDatabaseSetOption__AdbcDatabaseP.cCP.cCP.AdbcErrorP"></span><span class="target" id="group__adbc-database_1gac3c5e484e08aaa025de5ea94f7c69a04"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> < [...] -<dd><p>Set a char* option. </p> -<p>Options may be set before AdbcDatabaseInit. Some drivers may support setting options after initialization as well.</p> -<dl class="field-list simple"> -<dt class="field-odd">Returns<span class="colon">:</span></dt> -<dd class="field-odd"><p>ADBC_STATUS_NOT_IMPLEMENTED if the option is not recognized </p> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv416AdbcDatabaseInitP12AdbcDatabaseP9AdbcError"> -<span id="_CPPv316AdbcDatabaseInitP12AdbcDatabaseP9AdbcError"></span><span id="_CPPv216AdbcDatabaseInitP12AdbcDatabaseP9AdbcError"></span><span id="AdbcDatabaseInit__AdbcDatabaseP.AdbcErrorP"></span><span class="target" id="group__adbc-database_1ga77c62d4b89455326da63f99e3356016b"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="sig-name descnam [...] -<dd><p>Finish setting options and initialize the database. </p> -<p>Some drivers may support setting options after initialization as well. </p> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv419AdbcDatabaseReleaseP12AdbcDatabaseP9AdbcError"> -<span id="_CPPv319AdbcDatabaseReleaseP12AdbcDatabaseP9AdbcError"></span><span id="_CPPv219AdbcDatabaseReleaseP12AdbcDatabaseP9AdbcError"></span><span id="AdbcDatabaseRelease__AdbcDatabaseP.AdbcErrorP"></span><span class="target" id="group__adbc-database_1ga73c9d27f199b0ec9c016ae8d47deb475"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="sig-nam [...] -<dd><p>Destroy this database. No connections may exist. </p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>database</strong> – <strong>[in]</strong> The database to release. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> An optional location to return an error message if necessary. </p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv417AdbcConnectionNewP14AdbcConnectionP9AdbcError"> -<span id="_CPPv317AdbcConnectionNewP14AdbcConnectionP9AdbcError"></span><span id="_CPPv217AdbcConnectionNewP14AdbcConnectionP9AdbcError"></span><span id="AdbcConnectionNew__AdbcConnectionP.AdbcErrorP"></span><span class="target" id="group__adbc-connection_1ga468142c78d31848febba390d6f4e7285"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="sig-n [...] -<dd><p>Allocate a new (but uninitialized) connection. </p> -<p>Callers pass in a zero-initialized <a class="reference internal" href="#structAdbcConnection"><span class="std std-ref">AdbcConnection</span></a>.</p> -<p>Drivers should allocate their internal data structure and set the private_data field to point to the newly allocated struct. This struct should be released when AdbcConnectionRelease is called. </p> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv423AdbcConnectionSetOptionP14AdbcConnectionPKcPKcP9AdbcError"> -<span id="_CPPv323AdbcConnectionSetOptionP14AdbcConnectionPKcPKcP9AdbcError"></span><span id="_CPPv223AdbcConnectionSetOptionP14AdbcConnectionPKcPKcP9AdbcError"></span><span id="AdbcConnectionSetOption__AdbcConnectionP.cCP.cCP.AdbcErrorP"></span><span class="target" id="group__adbc-connection_1ga05138fc1a1b6c90c705d22bcc9249d03"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><spa [...] -<dd><p>Set a char* option. </p> -<p>Options may be set before AdbcConnectionInit. Some drivers may support setting options after initialization as well.</p> -<dl class="field-list simple"> -<dt class="field-odd">Returns<span class="colon">:</span></dt> -<dd class="field-odd"><p>ADBC_STATUS_NOT_IMPLEMENTED if the option is not recognized </p> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv418AdbcConnectionInitP14AdbcConnectionP12AdbcDatabaseP9AdbcError"> -<span id="_CPPv318AdbcConnectionInitP14AdbcConnectionP12AdbcDatabaseP9AdbcError"></span><span id="_CPPv218AdbcConnectionInitP14AdbcConnectionP12AdbcDatabaseP9AdbcError"></span><span id="AdbcConnectionInit__AdbcConnectionP.AdbcDatabaseP.AdbcErrorP"></span><span class="target" id="group__adbc-connection_1gad2e96c4760c6f320b66861ae68fa7247"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span [...] -<dd><p>Finish setting options and initialize the connection. </p> -<p>Some drivers may support setting options after initialization as well. </p> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv421AdbcConnectionReleaseP14AdbcConnectionP9AdbcError"> -<span id="_CPPv321AdbcConnectionReleaseP14AdbcConnectionP9AdbcError"></span><span id="_CPPv221AdbcConnectionReleaseP14AdbcConnectionP9AdbcError"></span><span id="AdbcConnectionRelease__AdbcConnectionP.AdbcErrorP"></span><span class="target" id="group__adbc-connection_1ga73eb78c8af5fda137933c69c3c5bff82"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span [...] -<dd><p>Destroy this connection. </p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>connection</strong> – <strong>[in]</strong> The connection to release. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> An optional location to return an error message if necessary. </p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv421AdbcConnectionGetInfoP14AdbcConnectionP8uint32_t6size_tP16ArrowArrayStreamP9AdbcError"> -<span id="_CPPv321AdbcConnectionGetInfoP14AdbcConnectionP8uint32_t6size_tP16ArrowArrayStreamP9AdbcError"></span><span id="_CPPv221AdbcConnectionGetInfoP14AdbcConnectionP8uint32_t6size_tP16ArrowArrayStreamP9AdbcError"></span><span id="AdbcConnectionGetInfo__AdbcConnectionP.uint32_tP.s.ArrowArrayStreamP.AdbcErrorP"></span><span class="target" id="group__adbc-connection-metadata_1ga72f6253a8bee78ad201f30ceb1ef3f4c"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="A [...] -<dd><p>Get metadata about the database/driver. </p> -<p>The result is an Arrow dataset with the following schema:</p> -<p><div class="table-wrapper colwidths-auto docutils container"> -<table class="docutils align-default"> -<thead> -<tr class="row-odd"><th class="head"><p>Field Name </p></th> -<th class="head"><p>Field Type </p></th> -</tr> -</thead> -<tbody> -<tr class="row-even"><td><p>info_name </p></td> -<td><p>uint32 not null </p></td> -</tr> -<tr class="row-odd"><td><p>info_value </p></td> -<td><p>INFO_SCHEMA </p></td> -</tr> -</tbody> -</table> -</div> -</p> -<p>INFO_SCHEMA is a dense union with members:</p> -<p><div class="table-wrapper colwidths-auto docutils container"> -<table class="docutils align-default"> -<thead> -<tr class="row-odd"><th class="head"><p>Field Name (Type Code) </p></th> -<th class="head"><p>Field Type </p></th> -</tr> -</thead> -<tbody> -<tr class="row-even"><td><p>string_value (0) </p></td> -<td><p>utf8 </p></td> -</tr> -<tr class="row-odd"><td><p>bool_value (1) </p></td> -<td><p>bool </p></td> -</tr> -<tr class="row-even"><td><p>int64_value (2) </p></td> -<td><p>int64 </p></td> -</tr> -<tr class="row-odd"><td><p>int32_bitmask (3) </p></td> -<td><p>int32 </p></td> -</tr> -<tr class="row-even"><td><p>string_list (4) </p></td> -<td><p>list<utf8> </p></td> -</tr> -<tr class="row-odd"><td><p>int32_to_int32_list_map (5) </p></td> -<td><p>map<int32, list<int32>> </p></td> -</tr> -</tbody> -</table> -</div> -</p> -<p>Each metadatum is identified by an integer code. The recognized codes are defined as constants. Codes [0, 10_000) are reserved for ADBC usage. Drivers/vendors will ignore requests for unrecognized codes (the row will be omitted from the result).</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>connection</strong> – <strong>[in]</strong> The connection to query. </p></li> -<li><p><strong>info_codes</strong> – <strong>[in]</strong> A list of metadata codes to fetch, or NULL to fetch all. </p></li> -<li><p><strong>info_codes_length</strong> – <strong>[in]</strong> The length of the info_codes parameter. Ignored if info_codes is NULL. </p></li> -<li><p><strong>out</strong> – <strong>[out]</strong> The result set. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> Error details, if an error occurs. </p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv424AdbcConnectionGetObjectsP14AdbcConnectioniPKcPKcPKcPPKcPKcP16ArrowArrayStreamP9AdbcError"> -<span id="_CPPv324AdbcConnectionGetObjectsP14AdbcConnectioniPKcPKcPKcPPKcPKcP16ArrowArrayStreamP9AdbcError"></span><span id="_CPPv224AdbcConnectionGetObjectsP14AdbcConnectioniPKcPKcPKcPPKcPKcP16ArrowArrayStreamP9AdbcError"></span><span id="AdbcConnectionGetObjects__AdbcConnectionP.i.cCP.cCP.cCP.cCPP.cCP.ArrowArrayStreamP.AdbcErrorP"></span><span class="target" id="group__adbc-connection-metadata_1ga32f64f4cfc86140e2d8d02b328215dbf"></span><a class="reference internal" href="#_CPPv414Adbc [...] -<dd><p>Get a hierarchical view of all catalogs, database schemas, tables, and columns. </p> -<p>The result is an Arrow dataset with the following schema:</p> -<p><div class="table-wrapper colwidths-auto docutils container"> -<table class="docutils align-default"> -<thead> -<tr class="row-odd"><th class="head"><p>Field Name </p></th> -<th class="head"><p>Field Type </p></th> -</tr> -</thead> -<tbody> -<tr class="row-even"><td><p>catalog_name </p></td> -<td><p>utf8 </p></td> -</tr> -<tr class="row-odd"><td><p>catalog_db_schemas </p></td> -<td><p>list<DB_SCHEMA_SCHEMA> </p></td> -</tr> -</tbody> -</table> -</div> -</p> -<p>DB_SCHEMA_SCHEMA is a Struct with fields:</p> -<p><div class="table-wrapper colwidths-auto docutils container"> -<table class="docutils align-default"> -<thead> -<tr class="row-odd"><th class="head"><p>Field Name </p></th> -<th class="head"><p>Field Type </p></th> -</tr> -</thead> -<tbody> -<tr class="row-even"><td><p>db_schema_name </p></td> -<td><p>utf8 </p></td> -</tr> -<tr class="row-odd"><td><p>db_schema_tables </p></td> -<td><p>list<TABLE_SCHEMA> </p></td> -</tr> -</tbody> -</table> -</div> -</p> -<p>TABLE_SCHEMA is a Struct with fields:</p> -<p><div class="table-wrapper colwidths-auto docutils container"> -<table class="docutils align-default"> -<thead> -<tr class="row-odd"><th class="head"><p>Field Name </p></th> -<th class="head"><p>Field Type </p></th> -</tr> -</thead> -<tbody> -<tr class="row-even"><td><p>table_name </p></td> -<td><p>utf8 not null </p></td> -</tr> -<tr class="row-odd"><td><p>table_type </p></td> -<td><p>utf8 not null </p></td> -</tr> -<tr class="row-even"><td><p>table_columns </p></td> -<td><p>list<COLUMN_SCHEMA> </p></td> -</tr> -<tr class="row-odd"><td><p>table_constraints </p></td> -<td><p>list<CONSTRAINT_SCHEMA> </p></td> -</tr> -</tbody> -</table> -</div> -</p> -<p>COLUMN_SCHEMA is a Struct with fields:</p> -<p><div class="table-wrapper colwidths-auto docutils container"> -<table class="docutils align-default"> -<thead> -<tr class="row-odd"><th class="head"><p>Field Name </p></th> -<th class="head"><p>Field Type </p></th> -<th class="head"><p>Comments </p></th> -</tr> -</thead> -<tbody> -<tr class="row-even"><td><p>column_name </p></td> -<td><p>utf8 not null </p></td> -<td><p></p></td> -</tr> -<tr class="row-odd"><td><p>ordinal_position </p></td> -<td><p>int32 </p></td> -<td><p>(1) </p></td> -</tr> -<tr class="row-even"><td><p>remarks </p></td> -<td><p>utf8 </p></td> -<td><p>(2) </p></td> -</tr> -<tr class="row-odd"><td><p>xdbc_data_type </p></td> -<td><p>int16 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-even"><td><p>xdbc_type_name </p></td> -<td><p>utf8 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-odd"><td><p>xdbc_column_size </p></td> -<td><p>int32 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-even"><td><p>xdbc_decimal_digits </p></td> -<td><p>int16 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-odd"><td><p>xdbc_num_prec_radix </p></td> -<td><p>int16 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-even"><td><p>xdbc_nullable </p></td> -<td><p>int16 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-odd"><td><p>xdbc_column_def </p></td> -<td><p>utf8 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-even"><td><p>xdbc_sql_data_type </p></td> -<td><p>int16 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-odd"><td><p>xdbc_datetime_sub </p></td> -<td><p>int16 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-even"><td><p>xdbc_char_octet_length </p></td> -<td><p>int32 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-odd"><td><p>xdbc_is_nullable </p></td> -<td><p>utf8 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-even"><td><p>xdbc_scope_catalog </p></td> -<td><p>utf8 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-odd"><td><p>xdbc_scope_schema </p></td> -<td><p>utf8 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-even"><td><p>xdbc_scope_table </p></td> -<td><p>utf8 </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-odd"><td><p>xdbc_is_autoincrement </p></td> -<td><p>bool </p></td> -<td><p>(3) </p></td> -</tr> -<tr class="row-even"><td><p>xdbc_is_generatedcolumn </p></td> -<td><p>bool </p></td> -<td><p>(3) </p></td> -</tr> -</tbody> -</table> -</div> -</p> -<p><ol class="loweralpha simple"> -<li><p>The column’s ordinal position in the table (starting from 1).</p></li> -<li><p>Database-specific description of the column.</p></li> -<li><p>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.</p></li> -</ol> -</p> -<p>CONSTRAINT_SCHEMA is a Struct with fields:</p> -<p><div class="table-wrapper colwidths-auto docutils container"> -<table class="docutils align-default"> -<thead> -<tr class="row-odd"><th class="head"><p>Field Name </p></th> -<th class="head"><p>Field Type </p></th> -<th class="head"><p>Comments </p></th> -</tr> -</thead> -<tbody> -<tr class="row-even"><td><p>constraint_name </p></td> -<td><p>utf8 </p></td> -<td><p></p></td> -</tr> -<tr class="row-odd"><td><p>constraint_type </p></td> -<td><p>utf8 not null </p></td> -<td><p>(1) </p></td> -</tr> -<tr class="row-even"><td><p>constraint_column_names </p></td> -<td><p>list<utf8> not null </p></td> -<td><p>(2) </p></td> -</tr> -<tr class="row-odd"><td><p>constraint_column_usage </p></td> -<td><p>list<USAGE_SCHEMA> </p></td> -<td><p>(3) </p></td> -</tr> -</tbody> -</table> -</div> -</p> -<p><ol class="loweralpha simple"> -<li><p>One of ‘CHECK’, ‘FOREIGN KEY’, ‘PRIMARY KEY’, or ‘UNIQUE’.</p></li> -<li><p>The columns on the current table that are constrained, in order.</p></li> -<li><p>For FOREIGN KEY only, the referenced table and columns.</p></li> -</ol> -</p> -<p>USAGE_SCHEMA is a Struct with fields:</p> -<p><div class="table-wrapper colwidths-auto docutils container"> -<table class="docutils align-default"> -<thead> -<tr class="row-odd"><th class="head"><p>Field Name </p></th> -<th class="head"><p>Field Type </p></th> -</tr> -</thead> -<tbody> -<tr class="row-even"><td><p>fk_catalog </p></td> -<td><p>utf8 </p></td> -</tr> -<tr class="row-odd"><td><p>fk_db_schema </p></td> -<td><p>utf8 </p></td> -</tr> -<tr class="row-even"><td><p>fk_table </p></td> -<td><p>utf8 not null </p></td> -</tr> -<tr class="row-odd"><td><p>fk_column_name </p></td> -<td><p>utf8 not null </p></td> -</tr> -</tbody> -</table> -</div> -</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>connection</strong> – <strong>[in]</strong> The database connection. </p></li> -<li><p><strong>depth</strong> – <strong>[in]</strong> The level of nesting to display. If 0, display all levels. If 1, display only catalogs (i.e. catalog_schemas will be null). If 2, display only catalogs and schemas (i.e. db_schema_tables will be null), and so on. </p></li> -<li><p><strong>catalog</strong> – <strong>[in]</strong> Only show tables in the given catalog. If NULL, do not filter by catalog. If an empty string, only show tables without a catalog. May be a search pattern (see section documentation). </p></li> -<li><p><strong>db_schema</strong> – <strong>[in]</strong> Only show tables in the given database schema. If NULL, do not filter by database schema. If an empty string, only show tables without a database schema. May be a search pattern (see section documentation). </p></li> -<li><p><strong>table_name</strong> – <strong>[in]</strong> Only show tables with the given name. If NULL, do not filter by name. May be a search pattern (see section documentation). </p></li> -<li><p><strong>table_type</strong> – <strong>[in]</strong> Only show tables matching one of the given table types. If NULL, show tables of any type. Valid table types can be fetched from GetTableTypes. Terminate the list with a NULL entry. </p></li> -<li><p><strong>column_name</strong> – <strong>[in]</strong> Only show columns with the given name. If NULL, do not filter by name. May be a search pattern (see section documentation). </p></li> -<li><p><strong>out</strong> – <strong>[out]</strong> The result set. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> Error details, if an error occurs. </p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv428AdbcConnectionGetTableSchemaP14AdbcConnectionPKcPKcPKcP11ArrowSchemaP9AdbcError"> -<span id="_CPPv328AdbcConnectionGetTableSchemaP14AdbcConnectionPKcPKcPKcP11ArrowSchemaP9AdbcError"></span><span id="_CPPv228AdbcConnectionGetTableSchemaP14AdbcConnectionPKcPKcPKcP11ArrowSchemaP9AdbcError"></span><span id="AdbcConnectionGetTableSchema__AdbcConnectionP.cCP.cCP.cCP.ArrowSchemaP.AdbcErrorP"></span><span class="target" id="group__adbc-connection-metadata_1gaf66785f025c4f00c0e0cb9639bf3a32b"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusC [...] -<dd><p>Get the Arrow schema of a table. </p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>connection</strong> – <strong>[in]</strong> The database connection. </p></li> -<li><p><strong>catalog</strong> – <strong>[in]</strong> The catalog (or nullptr if not applicable). </p></li> -<li><p><strong>db_schema</strong> – <strong>[in]</strong> The database schema (or nullptr if not applicable). </p></li> -<li><p><strong>table_name</strong> – <strong>[in]</strong> The table name. </p></li> -<li><p><strong>schema</strong> – <strong>[out]</strong> The table schema. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> Error details, if an error occurs. </p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv427AdbcConnectionGetTableTypesP14AdbcConnectionP16ArrowArrayStreamP9AdbcError"> -<span id="_CPPv327AdbcConnectionGetTableTypesP14AdbcConnectionP16ArrowArrayStreamP9AdbcError"></span><span id="_CPPv227AdbcConnectionGetTableTypesP14AdbcConnectionP16ArrowArrayStreamP9AdbcError"></span><span id="AdbcConnectionGetTableTypes__AdbcConnectionP.ArrowArrayStreamP.AdbcErrorP"></span><span class="target" id="group__adbc-connection-metadata_1ga36f82429722f79fce841909ad6ac66a8"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class=" [...] -<dd><p>Get a list of table types in the database. </p> -<p>The result is an Arrow dataset with the following schema:</p> -<p><div class="table-wrapper colwidths-auto docutils container"> -<table class="docutils align-default"> -<thead> -<tr class="row-odd"><th class="head"><p>Field Name </p></th> -<th class="head"><p>Field Type </p></th> -</tr> -</thead> -<tbody> -<tr class="row-even"><td><p>table_type </p></td> -<td><p>utf8 not null </p></td> -</tr> -</tbody> -</table> -</div> -</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>connection</strong> – <strong>[in]</strong> The database connection. </p></li> -<li><p><strong>out</strong> – <strong>[out]</strong> The result set. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> Error details, if an error occurs. </p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv427AdbcConnectionReadPartitionP14AdbcConnectionPK7uint8_t6size_tP16ArrowArrayStreamP9AdbcError"> -<span id="_CPPv327AdbcConnectionReadPartitionP14AdbcConnectionPK7uint8_t6size_tP16ArrowArrayStreamP9AdbcError"></span><span id="_CPPv227AdbcConnectionReadPartitionP14AdbcConnectionPK7uint8_t6size_tP16ArrowArrayStreamP9AdbcError"></span><span id="AdbcConnectionReadPartition__AdbcConnectionP.uint8_tCP.s.ArrowArrayStreamP.AdbcErrorP"></span><span class="target" id="group__adbc-connection-partition_1ga71ee9dae49504eace22d4d4f9edbf137"></span><a class="reference internal" href="#_CPPv414AdbcS [...] -<dd><p>Construct a statement for a partition of a query. The results can then be read independently. </p> -<p>A partition can be retrieved from <a class="reference internal" href="#structAdbcPartitions"><span class="std std-ref">AdbcPartitions</span></a>.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>connection</strong> – <strong>[in]</strong> The connection to use. This does not have to be the same connection that the partition was created on. </p></li> -<li><p><strong>serialized_partition</strong> – <strong>[in]</strong> The partition descriptor. </p></li> -<li><p><strong>serialized_length</strong> – <strong>[in]</strong> The partition descriptor length. </p></li> -<li><p><strong>out</strong> – <strong>[out]</strong> The result set. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> Error details, if an error occurs. </p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv420AdbcConnectionCommitP14AdbcConnectionP9AdbcError"> -<span id="_CPPv320AdbcConnectionCommitP14AdbcConnectionP9AdbcError"></span><span id="_CPPv220AdbcConnectionCommitP14AdbcConnectionP9AdbcError"></span><span id="AdbcConnectionCommit__AdbcConnectionP.AdbcErrorP"></span><span class="target" id="group__adbc-connection-transaction_1ga6ccaae9a2a25f0b96afa5c3bd0fcf3d8"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </sp [...] -<dd><p>Commit any pending transactions. Only used if autocommit is disabled. </p> -<p>Behavior is undefined if this is mixed with SQL transaction statements. </p> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv422AdbcConnectionRollbackP14AdbcConnectionP9AdbcError"> -<span id="_CPPv322AdbcConnectionRollbackP14AdbcConnectionP9AdbcError"></span><span id="_CPPv222AdbcConnectionRollbackP14AdbcConnectionP9AdbcError"></span><span id="AdbcConnectionRollback__AdbcConnectionP.AdbcErrorP"></span><span class="target" id="group__adbc-connection-transaction_1gab8e2f8bbe37f4e526e18d3ee2c1e1403"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w" [...] -<dd><p>Roll back any pending transactions. Only used if autocommit is disabled. </p> -<p>Behavior is undefined if this is mixed with SQL transaction statements. </p> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv416AdbcStatementNewP14AdbcConnectionP13AdbcStatementP9AdbcError"> -<span id="_CPPv316AdbcStatementNewP14AdbcConnectionP13AdbcStatementP9AdbcError"></span><span id="_CPPv216AdbcStatementNewP14AdbcConnectionP13AdbcStatementP9AdbcError"></span><span id="AdbcStatementNew__AdbcConnectionP.AdbcStatementP.AdbcErrorP"></span><span class="target" id="group__adbc-statement_1gab81e98bf3871f9b7ce1445fad39eddbd"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a [...] -<dd><p>Create a new statement for a given connection. </p> -<p>Callers pass in a zero-initialized <a class="reference internal" href="#structAdbcStatement"><span class="std std-ref">AdbcStatement</span></a>.</p> -<p>Drivers should allocate their internal data structure and set the private_data field to point to the newly allocated struct. This struct should be released when AdbcStatementRelease is called. </p> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv420AdbcStatementReleaseP13AdbcStatementP9AdbcError"> -<span id="_CPPv320AdbcStatementReleaseP13AdbcStatementP9AdbcError"></span><span id="_CPPv220AdbcStatementReleaseP13AdbcStatementP9AdbcError"></span><span id="AdbcStatementRelease__AdbcStatementP.AdbcErrorP"></span><span class="target" id="group__adbc-statement_1ga5c9caf425d3dd3d1a90c186de5619a49"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class=" [...] -<dd><p>Destroy a statement. </p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>statement</strong> – <strong>[in]</strong> The statement to release. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> An optional location to return an error message if necessary. </p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv425AdbcStatementExecuteQueryP13AdbcStatementP16ArrowArrayStreamP7int64_tP9AdbcError"> -<span id="_CPPv325AdbcStatementExecuteQueryP13AdbcStatementP16ArrowArrayStreamP7int64_tP9AdbcError"></span><span id="_CPPv225AdbcStatementExecuteQueryP13AdbcStatementP16ArrowArrayStreamP7int64_tP9AdbcError"></span><span id="AdbcStatementExecuteQuery__AdbcStatementP.ArrowArrayStreamP.int64_tP.AdbcErrorP"></span><span class="target" id="group__adbc-statement_1ga1f653045678d9d5d51780e37e3b644a6"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span [...] -<dd><p>Execute a statement and get the results. </p> -<p>This invalidates any prior result sets.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>statement</strong> – <strong>[in]</strong> The statement to execute. </p></li> -<li><p><strong>out</strong> – <strong>[out]</strong> The results. Pass NULL if the client does not expect a result set. </p></li> -<li><p><strong>rows_affected</strong> – <strong>[out]</strong> The number of rows affected if known, else -1. Pass NULL if the client does not want this information. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> An optional location to return an error message if necessary. </p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv420AdbcStatementPrepareP13AdbcStatementP9AdbcError"> -<span id="_CPPv320AdbcStatementPrepareP13AdbcStatementP9AdbcError"></span><span id="_CPPv220AdbcStatementPrepareP13AdbcStatementP9AdbcError"></span><span id="AdbcStatementPrepare__AdbcStatementP.AdbcErrorP"></span><span class="target" id="group__adbc-statement_1ga7fdcced63aa296686f536e2f4ce2eeb7"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class=" [...] -<dd><p>Turn this statement into a prepared statement to be executed multiple times. </p> -<p>This invalidates any prior result sets. </p> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv424AdbcStatementSetSqlQueryP13AdbcStatementPKcP9AdbcError"> -<span id="_CPPv324AdbcStatementSetSqlQueryP13AdbcStatementPKcP9AdbcError"></span><span id="_CPPv224AdbcStatementSetSqlQueryP13AdbcStatementPKcP9AdbcError"></span><span id="AdbcStatementSetSqlQuery__AdbcStatementP.cCP.AdbcErrorP"></span><span class="target" id="group__adbc-statement-sql_1ga40254bb2c39711f5d2772cb78f349e4a"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class [...] -<dd><p>Set the SQL query to execute. </p> -<p>The query can then be executed with AdbcStatementExecute. For queries expected to be executed repeatedly, AdbcStatementPrepare the statement first.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>statement</strong> – <strong>[in]</strong> The statement. </p></li> -<li><p><strong>query</strong> – <strong>[in]</strong> The query to execute. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> Error details, if an error occurs. </p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv429AdbcStatementSetSubstraitPlanP13AdbcStatementPK7uint8_t6size_tP9AdbcError"> -<span id="_CPPv329AdbcStatementSetSubstraitPlanP13AdbcStatementPK7uint8_t6size_tP9AdbcError"></span><span id="_CPPv229AdbcStatementSetSubstraitPlanP13AdbcStatementPK7uint8_t6size_tP9AdbcError"></span><span id="AdbcStatementSetSubstraitPlan__AdbcStatementP.uint8_tCP.s.AdbcErrorP"></span><span class="target" id="group__adbc-statement-substrait_1gad364441ba9ff3c37fda26a0e4b33721a"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><spa [...] -<dd><p>Set the Substrait plan to execute. </p> -<p>The query can then be executed with AdbcStatementExecute. For queries expected to be executed repeatedly, AdbcStatementPrepare the statement first.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>statement</strong> – <strong>[in]</strong> The statement. </p></li> -<li><p><strong>plan</strong> – <strong>[in]</strong> The serialized substrait.Plan to execute. </p></li> -<li><p><strong>length</strong> – <strong>[in]</strong> The length of the serialized plan. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> Error details, if an error occurs. </p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv417AdbcStatementBindP13AdbcStatementP10ArrowArrayP11ArrowSchemaP9AdbcError"> -<span id="_CPPv317AdbcStatementBindP13AdbcStatementP10ArrowArrayP11ArrowSchemaP9AdbcError"></span><span id="_CPPv217AdbcStatementBindP13AdbcStatementP10ArrowArrayP11ArrowSchemaP9AdbcError"></span><span id="AdbcStatementBind__AdbcStatementP.ArrowArrayP.ArrowSchemaP.AdbcErrorP"></span><span class="target" id="group__adbc-statement_1ga93c7cab9850344161aad636dcdb00265"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre" [...] -<dd><p>Bind Arrow data. This can be used for bulk inserts or prepared statements. </p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>statement</strong> – <strong>[in]</strong> The statement to bind to. </p></li> -<li><p><strong>values</strong> – <strong>[in]</strong> The values to bind. The driver will call the release callback itself, although it may not do this until the statement is released. </p></li> -<li><p><strong>schema</strong> – <strong>[in]</strong> The schema of the values to bind. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> An optional location to return an error message if necessary. </p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv423AdbcStatementBindStreamP13AdbcStatementP16ArrowArrayStreamP9AdbcError"> -<span id="_CPPv323AdbcStatementBindStreamP13AdbcStatementP16ArrowArrayStreamP9AdbcError"></span><span id="_CPPv223AdbcStatementBindStreamP13AdbcStatementP16ArrowArrayStreamP9AdbcError"></span><span id="AdbcStatementBindStream__AdbcStatementP.ArrowArrayStreamP.AdbcErrorP"></span><span class="target" id="group__adbc-statement_1ga89e2158e03e0f2e7425ff7d95d078f29"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">Adbc [...] -<dd><p>Bind Arrow data. This can be used for bulk inserts or prepared statements. </p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>statement</strong> – <strong>[in]</strong> The statement to bind to. </p></li> -<li><p><strong>stream</strong> – <strong>[in]</strong> The values to bind. The driver will call the release callback itself, although it may not do this until the statement is released. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> An optional location to return an error message if necessary. </p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv431AdbcStatementGetParameterSchemaP13AdbcStatementP11ArrowSchemaP9AdbcError"> -<span id="_CPPv331AdbcStatementGetParameterSchemaP13AdbcStatementP11ArrowSchemaP9AdbcError"></span><span id="_CPPv231AdbcStatementGetParameterSchemaP13AdbcStatementP11ArrowSchemaP9AdbcError"></span><span id="AdbcStatementGetParameterSchema__AdbcStatementP.ArrowSchemaP.AdbcErrorP"></span><span class="target" id="group__adbc-statement_1ga429e02001dd6656b4a068e906b9de16e"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class=" [...] -<dd><p>Get the schema for bound parameters. </p> -<p>This retrieves an Arrow schema describing the number, names, and types of the parameters in a parameterized statement. The fields of the schema should be in order of the ordinal position of the parameters; named parameters should appear only once.</p> -<p>If the parameter does not have a name, or the name cannot be determined, the name of the corresponding field in the schema will be an empty string. If the type cannot be determined, the type of the corresponding field will be NA (NullType).</p> -<p>This should be called after AdbcStatementPrepare.</p> -<dl class="field-list simple"> -<dt class="field-odd">Returns<span class="colon">:</span></dt> -<dd class="field-odd"><p>ADBC_STATUS_NOT_IMPLEMENTED if the schema cannot be determined. </p> -</dd> -</dl> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv422AdbcStatementSetOptionP13AdbcStatementPKcPKcP9AdbcError"> -<span id="_CPPv322AdbcStatementSetOptionP13AdbcStatementPKcPKcP9AdbcError"></span><span id="_CPPv222AdbcStatementSetOptionP13AdbcStatementPKcPKcP9AdbcError"></span><span id="AdbcStatementSetOption__AdbcStatementP.cCP.cCP.AdbcErrorP"></span><span class="target" id="group__adbc-statement_1ga6a7ed91953603db7c60c0ab01d52ea29"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class [...] -<dd><p>Set a string option on a statement. </p> -</dd></dl> - -<dl class="cpp function"> -<dt class="sig sig-object cpp" id="_CPPv430AdbcStatementExecutePartitionsP13AdbcStatementP11ArrowSchemaP14AdbcPartitionsP7int64_tP9AdbcError"> -<span id="_CPPv330AdbcStatementExecutePartitionsP13AdbcStatementP11ArrowSchemaP14AdbcPartitionsP7int64_tP9AdbcError"></span><span id="_CPPv230AdbcStatementExecutePartitionsP13AdbcStatementP11ArrowSchemaP14AdbcPartitionsP7int64_tP9AdbcError"></span><span id="AdbcStatementExecutePartitions__AdbcStatementP.ArrowSchemaP.AdbcPartitionsP.int64_tP.AdbcErrorP"></span><span class="target" id="group__adbc-statement-partition_1ga4ad4068421a6e7d3fff41939ca757c77"></span><a class="reference internal" [...] -<dd><p>Execute a statement and get the results as a partitioned result set. </p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>statement</strong> – <strong>[in]</strong> The statement to execute. </p></li> -<li><p><strong>schema</strong> – <strong>[out]</strong> The schema of the result set. </p></li> -<li><p><strong>partitions</strong> – <strong>[out]</strong> The result partitions. </p></li> -<li><p><strong>rows_affected</strong> – <strong>[out]</strong> The number of rows affected if known, else -1. Pass NULL if the client does not want this information. </p></li> -<li><p><strong>error</strong> – <strong>[out]</strong> An optional location to return an error message if necessary. </p></li> -</ul> -</dd> -<dt class="field-even">Returns<span class="colon">:</span></dt> -<dd class="field-even"><p>ADBC_STATUS_NOT_IMPLEMENTED if the driver does not support partitioned results </p> -</dd> -</dl> -</dd></dl> - </div> <dl class="cpp struct"> <dt class="sig sig-object cpp" id="_CPPv49AdbcError"> @@ -1561,139 +516,139 @@ <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver7releaseE"> -<span id="_CPPv3N10AdbcDriver7releaseE"></span><span id="_CPPv2N10AdbcDriver7releaseE"></span><span class="target" id="structAdbcDriver_1a2b16d855667a25225402fedaa67989a0"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span cla [...] +<span id="_CPPv3N10AdbcDriver7releaseE"></span><span id="_CPPv2N10AdbcDriver7releaseE"></span><span class="target" id="structAdbcDriver_1a2b16d855667a25225402fedaa67989a0"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">release</span></span></span><span class="p"><span class="pre">) [...] <dd><p>Release the driver and perform any cleanup. </p> <p>This is an embedded callback to make it easier for the driver manager and driver to cooperate. </p> </dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver12DatabaseInitE"> -<span id="_CPPv3N10AdbcDriver12DatabaseInitE"></span><span id="_CPPv2N10AdbcDriver12DatabaseInitE"></span><span class="target" id="structAdbcDriver_1ac01ff353074c64d81144b784e8035c9e"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descnam [...] +<span id="_CPPv3N10AdbcDriver12DatabaseInitE"></span><span id="_CPPv2N10AdbcDriver12DatabaseInitE"></span><span class="target" id="structAdbcDriver_1ac01ff353074c64d81144b784e8035c9e"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">DatabaseInit</span></span></span><span class="p"><s [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver11DatabaseNewE"> -<span id="_CPPv3N10AdbcDriver11DatabaseNewE"></span><span id="_CPPv2N10AdbcDriver11DatabaseNewE"></span><span class="target" id="structAdbcDriver_1a885bf2cf6bd1d31f8c3852522bbac7cb"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname" [...] +<span id="_CPPv3N10AdbcDriver11DatabaseNewE"></span><span id="_CPPv2N10AdbcDriver11DatabaseNewE"></span><span class="target" id="structAdbcDriver_1a885bf2cf6bd1d31f8c3852522bbac7cb"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">DatabaseNew</span></span></span><span class="p"><span [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver17DatabaseSetOptionE"> -<span id="_CPPv3N10AdbcDriver17DatabaseSetOptionE"></span><span id="_CPPv2N10AdbcDriver17DatabaseSetOptionE"></span><span class="target" id="structAdbcDriver_1a4c412727520e6bc1961fd0fc09a56a69"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-na [...] +<span id="_CPPv3N10AdbcDriver17DatabaseSetOptionE"></span><span id="_CPPv2N10AdbcDriver17DatabaseSetOptionE"></span><span class="target" id="structAdbcDriver_1a4c412727520e6bc1961fd0fc09a56a69"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">DatabaseSetOption</span></span></span><sp [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver15DatabaseReleaseE"> -<span id="_CPPv3N10AdbcDriver15DatabaseReleaseE"></span><span id="_CPPv2N10AdbcDriver15DatabaseReleaseE"></span><span class="target" id="structAdbcDriver_1a3df8054c00398c9fcf7bb0024c01f601"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name d [...] +<span id="_CPPv3N10AdbcDriver15DatabaseReleaseE"></span><span id="_CPPv2N10AdbcDriver15DatabaseReleaseE"></span><span class="target" id="structAdbcDriver_1a3df8054c00398c9fcf7bb0024c01f601"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">DatabaseRelease</span></span></span><span cla [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver16ConnectionCommitE"> -<span id="_CPPv3N10AdbcDriver16ConnectionCommitE"></span><span id="_CPPv2N10AdbcDriver16ConnectionCommitE"></span><span class="target" id="structAdbcDriver_1ae744b2944b2b28b62334dc5950df93bd"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name [...] +<span id="_CPPv3N10AdbcDriver16ConnectionCommitE"></span><span id="_CPPv2N10AdbcDriver16ConnectionCommitE"></span><span class="target" id="structAdbcDriver_1ae744b2944b2b28b62334dc5950df93bd"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionCommit</span></span></span><span [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver17ConnectionGetInfoE"> -<span id="_CPPv3N10AdbcDriver17ConnectionGetInfoE"></span><span id="_CPPv2N10AdbcDriver17ConnectionGetInfoE"></span><span class="target" id="structAdbcDriver_1a1eef1c652948ec2de46d34631c6e358e"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-na [...] +<span id="_CPPv3N10AdbcDriver17ConnectionGetInfoE"></span><span id="_CPPv2N10AdbcDriver17ConnectionGetInfoE"></span><span class="target" id="structAdbcDriver_1a1eef1c652948ec2de46d34631c6e358e"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionGetInfo</span></span></span><sp [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver20ConnectionGetObjectsE"> -<span id="_CPPv3N10AdbcDriver20ConnectionGetObjectsE"></span><span id="_CPPv2N10AdbcDriver20ConnectionGetObjectsE"></span><span class="target" id="structAdbcDriver_1a8315bf6354ada180a6512fa0a54ebbb8"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class=" [...] +<span id="_CPPv3N10AdbcDriver20ConnectionGetObjectsE"></span><span id="_CPPv2N10AdbcDriver20ConnectionGetObjectsE"></span><span class="target" id="structAdbcDriver_1a8315bf6354ada180a6512fa0a54ebbb8"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionGetObjects</span></span>< [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver24ConnectionGetTableSchemaE"> -<span id="_CPPv3N10AdbcDriver24ConnectionGetTableSchemaE"></span><span id="_CPPv2N10AdbcDriver24ConnectionGetTableSchemaE"></span><span class="target" id="structAdbcDriver_1a1d26143ead6993a715c17293a8174b2e"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span [...] +<span id="_CPPv3N10AdbcDriver24ConnectionGetTableSchemaE"></span><span id="_CPPv2N10AdbcDriver24ConnectionGetTableSchemaE"></span><span class="target" id="structAdbcDriver_1a1d26143ead6993a715c17293a8174b2e"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionGetTableSchema</s [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver23ConnectionGetTableTypesE"> -<span id="_CPPv3N10AdbcDriver23ConnectionGetTableTypesE"></span><span id="_CPPv2N10AdbcDriver23ConnectionGetTableTypesE"></span><span class="target" id="structAdbcDriver_1a91179eb4c7e6c3ef9596a7b23d8cae8b"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span c [...] +<span id="_CPPv3N10AdbcDriver23ConnectionGetTableTypesE"></span><span id="_CPPv2N10AdbcDriver23ConnectionGetTableTypesE"></span><span class="target" id="structAdbcDriver_1a91179eb4c7e6c3ef9596a7b23d8cae8b"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionGetTableTypes</span [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver14ConnectionInitE"> -<span id="_CPPv3N10AdbcDriver14ConnectionInitE"></span><span id="_CPPv2N10AdbcDriver14ConnectionInitE"></span><span class="target" id="structAdbcDriver_1ad1e4b6ba37e8140d9beb669bc7b59dda"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name des [...] +<span id="_CPPv3N10AdbcDriver14ConnectionInitE"></span><span id="_CPPv2N10AdbcDriver14ConnectionInitE"></span><span class="target" id="structAdbcDriver_1ad1e4b6ba37e8140d9beb669bc7b59dda"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionInit</span></span></span><span class= [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver13ConnectionNewE"> -<span id="_CPPv3N10AdbcDriver13ConnectionNewE"></span><span id="_CPPv2N10AdbcDriver13ConnectionNewE"></span><span class="target" id="structAdbcDriver_1a454475a6c011fb86abb644322aa52f34"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descn [...] +<span id="_CPPv3N10AdbcDriver13ConnectionNewE"></span><span id="_CPPv2N10AdbcDriver13ConnectionNewE"></span><span class="target" id="structAdbcDriver_1a454475a6c011fb86abb644322aa52f34"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionNew</span></span></span><span class="p" [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver19ConnectionSetOptionE"> -<span id="_CPPv3N10AdbcDriver19ConnectionSetOptionE"></span><span id="_CPPv2N10AdbcDriver19ConnectionSetOptionE"></span><span class="target" id="structAdbcDriver_1a5f222fe821e0ae02762d339c781c4ea6"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="si [...] +<span id="_CPPv3N10AdbcDriver19ConnectionSetOptionE"></span><span id="_CPPv2N10AdbcDriver19ConnectionSetOptionE"></span><span class="target" id="structAdbcDriver_1a5f222fe821e0ae02762d339c781c4ea6"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionSetOption</span></span></sp [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver23ConnectionReadPartitionE"> -<span id="_CPPv3N10AdbcDriver23ConnectionReadPartitionE"></span><span id="_CPPv2N10AdbcDriver23ConnectionReadPartitionE"></span><span class="target" id="structAdbcDriver_1a7c8480231fa8c17dc65d7629ddc72195"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span c [...] +<span id="_CPPv3N10AdbcDriver23ConnectionReadPartitionE"></span><span id="_CPPv2N10AdbcDriver23ConnectionReadPartitionE"></span><span class="target" id="structAdbcDriver_1a7c8480231fa8c17dc65d7629ddc72195"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionReadPartition</span [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver17ConnectionReleaseE"> -<span id="_CPPv3N10AdbcDriver17ConnectionReleaseE"></span><span id="_CPPv2N10AdbcDriver17ConnectionReleaseE"></span><span class="target" id="structAdbcDriver_1af8cc5dff24dd73365c76a7ae3afa6557"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-na [...] +<span id="_CPPv3N10AdbcDriver17ConnectionReleaseE"></span><span id="_CPPv2N10AdbcDriver17ConnectionReleaseE"></span><span class="target" id="structAdbcDriver_1af8cc5dff24dd73365c76a7ae3afa6557"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionRelease</span></span></span><sp [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver18ConnectionRollbackE"> -<span id="_CPPv3N10AdbcDriver18ConnectionRollbackE"></span><span id="_CPPv2N10AdbcDriver18ConnectionRollbackE"></span><span class="target" id="structAdbcDriver_1af70758893aadd6451866ceb0ce433f41"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig- [...] +<span id="_CPPv3N10AdbcDriver18ConnectionRollbackE"></span><span id="_CPPv2N10AdbcDriver18ConnectionRollbackE"></span><span class="target" id="structAdbcDriver_1af70758893aadd6451866ceb0ce433f41"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ConnectionRollback</span></span></span> [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver13StatementBindE"> -<span id="_CPPv3N10AdbcDriver13StatementBindE"></span><span id="_CPPv2N10AdbcDriver13StatementBindE"></span><span class="target" id="structAdbcDriver_1a6ffcf398baaad8b832c0d597db42c657"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descn [...] +<span id="_CPPv3N10AdbcDriver13StatementBindE"></span><span id="_CPPv2N10AdbcDriver13StatementBindE"></span><span class="target" id="structAdbcDriver_1a6ffcf398baaad8b832c0d597db42c657"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementBind</span></span></span><span class="p" [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver19StatementBindStreamE"> -<span id="_CPPv3N10AdbcDriver19StatementBindStreamE"></span><span id="_CPPv2N10AdbcDriver19StatementBindStreamE"></span><span class="target" id="structAdbcDriver_1a35cd912a46aebded295af36b71f3d24f"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="si [...] +<span id="_CPPv3N10AdbcDriver19StatementBindStreamE"></span><span id="_CPPv2N10AdbcDriver19StatementBindStreamE"></span><span class="target" id="structAdbcDriver_1a35cd912a46aebded295af36b71f3d24f"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementBindStream</span></span></sp [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver21StatementExecuteQueryE"> -<span id="_CPPv3N10AdbcDriver21StatementExecuteQueryE"></span><span id="_CPPv2N10AdbcDriver21StatementExecuteQueryE"></span><span class="target" id="structAdbcDriver_1aa9700d80d4ce28dab9b302d3b1a91193"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class [...] +<span id="_CPPv3N10AdbcDriver21StatementExecuteQueryE"></span><span id="_CPPv2N10AdbcDriver21StatementExecuteQueryE"></span><span class="target" id="structAdbcDriver_1aa9700d80d4ce28dab9b302d3b1a91193"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementExecuteQuery</span></spa [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver26StatementExecutePartitionsE"> -<span id="_CPPv3N10AdbcDriver26StatementExecutePartitionsE"></span><span id="_CPPv2N10AdbcDriver26StatementExecutePartitionsE"></span><span class="target" id="structAdbcDriver_1aaaf4cf044fca466cf767a6346cee25fc"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span>< [...] +<span id="_CPPv3N10AdbcDriver26StatementExecutePartitionsE"></span><span id="_CPPv2N10AdbcDriver26StatementExecutePartitionsE"></span><span class="target" id="structAdbcDriver_1aaaf4cf044fca466cf767a6346cee25fc"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementExecutePartiti [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver27StatementGetParameterSchemaE"> -<span id="_CPPv3N10AdbcDriver27StatementGetParameterSchemaE"></span><span id="_CPPv2N10AdbcDriver27StatementGetParameterSchemaE"></span><span class="target" id="structAdbcDriver_1a127b86dcd7ae73e93f5ede25e66b33e8"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span [...] +<span id="_CPPv3N10AdbcDriver27StatementGetParameterSchemaE"></span><span id="_CPPv2N10AdbcDriver27StatementGetParameterSchemaE"></span><span class="target" id="structAdbcDriver_1a127b86dcd7ae73e93f5ede25e66b33e8"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementGetParameter [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver12StatementNewE"> -<span id="_CPPv3N10AdbcDriver12StatementNewE"></span><span id="_CPPv2N10AdbcDriver12StatementNewE"></span><span class="target" id="structAdbcDriver_1a73b93ce3f5e057a88ca1473c398b1b68"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descnam [...] +<span id="_CPPv3N10AdbcDriver12StatementNewE"></span><span id="_CPPv2N10AdbcDriver12StatementNewE"></span><span class="target" id="structAdbcDriver_1a73b93ce3f5e057a88ca1473c398b1b68"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementNew</span></span></span><span class="p"><s [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver16StatementPrepareE"> -<span id="_CPPv3N10AdbcDriver16StatementPrepareE"></span><span id="_CPPv2N10AdbcDriver16StatementPrepareE"></span><span class="target" id="structAdbcDriver_1adc850bd673fd9934abcac9b4e150ff45"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name [...] +<span id="_CPPv3N10AdbcDriver16StatementPrepareE"></span><span id="_CPPv2N10AdbcDriver16StatementPrepareE"></span><span class="target" id="structAdbcDriver_1adc850bd673fd9934abcac9b4e150ff45"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementPrepare</span></span></span><span [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver16StatementReleaseE"> -<span id="_CPPv3N10AdbcDriver16StatementReleaseE"></span><span id="_CPPv2N10AdbcDriver16StatementReleaseE"></span><span class="target" id="structAdbcDriver_1a2f5199fb1cf25854fdac24471c004621"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name [...] +<span id="_CPPv3N10AdbcDriver16StatementReleaseE"></span><span id="_CPPv2N10AdbcDriver16StatementReleaseE"></span><span class="target" id="structAdbcDriver_1a2f5199fb1cf25854fdac24471c004621"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementRelease</span></span></span><span [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver18StatementSetOptionE"> -<span id="_CPPv3N10AdbcDriver18StatementSetOptionE"></span><span id="_CPPv2N10AdbcDriver18StatementSetOptionE"></span><span class="target" id="structAdbcDriver_1ae0c5456548a2129afd7b539171a4d769"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig- [...] +<span id="_CPPv3N10AdbcDriver18StatementSetOptionE"></span><span id="_CPPv2N10AdbcDriver18StatementSetOptionE"></span><span class="target" id="structAdbcDriver_1ae0c5456548a2129afd7b539171a4d769"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementSetOption</span></span></span> [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver20StatementSetSqlQueryE"> -<span id="_CPPv3N10AdbcDriver20StatementSetSqlQueryE"></span><span id="_CPPv2N10AdbcDriver20StatementSetSqlQueryE"></span><span class="target" id="structAdbcDriver_1ad98ef8e5de7eec4da1af1f4b43b30fdb"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class=" [...] +<span id="_CPPv3N10AdbcDriver20StatementSetSqlQueryE"></span><span id="_CPPv2N10AdbcDriver20StatementSetSqlQueryE"></span><span class="target" id="structAdbcDriver_1ad98ef8e5de7eec4da1af1f4b43b30fdb"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementSetSqlQuery</span></span>< [...] <dd></dd></dl> <dl class="cpp var"> <dt class="sig sig-object cpp" id="_CPPv4N10AdbcDriver25StatementSetSubstraitPlanE"> -<span id="_CPPv3N10AdbcDriver25StatementSetSubstraitPlanE"></span><span id="_CPPv2N10AdbcDriver25StatementSetSubstraitPlanE"></span><span class="target" id="structAdbcDriver_1ac67de5713f011403ddbd3874b20e45c2"></span><a class="reference internal" href="#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><sp [...] +<span id="_CPPv3N10AdbcDriver25StatementSetSubstraitPlanE"></span><span id="_CPPv2N10AdbcDriver25StatementSetSubstraitPlanE"></span><span class="target" id="structAdbcDriver_1ac67de5713f011403ddbd3874b20e45c2"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">StatementSetSubstraitPlan [...] <dd></dd></dl> </div> diff --git a/main/cpp/api/adbc_driver_manager.html b/main/cpp/api/adbc_driver_manager.html index 3df76ed8..621ee9e2 100644 --- a/main/cpp/api/adbc_driver_manager.html +++ b/main/cpp/api/adbc_driver_manager.html @@ -333,7 +333,7 @@ <p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p> <dl class="cpp function"> <dt class="sig sig-object cpp" id="_CPPv414AdbcLoadDriverPKcPKciPvP9AdbcError"> -<span id="_CPPv314AdbcLoadDriverPKcPKciPvP9AdbcError"></span><span id="_CPPv214AdbcLoadDriverPKcPKciPvP9AdbcError"></span><span id="AdbcLoadDriver__cCP.cCP.i.voidP.AdbcErrorP"></span><span class="target" id="adbc__driver__manager_8h_1ac9a4db661a21cca1bbb47a4bd47f9ad0"></span><a class="reference internal" href="adbc.html#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode</span></span></a><span class="w"> </span><span class="sig-name descname">< [...] +<span id="_CPPv314AdbcLoadDriverPKcPKciPvP9AdbcError"></span><span id="_CPPv214AdbcLoadDriverPKcPKciPvP9AdbcError"></span><span id="AdbcLoadDriver__cCP.cCP.i.voidP.AdbcErrorP"></span><span class="target" id="adbc__driver__manager_8h_1ac9a4db661a21cca1bbb47a4bd47f9ad0"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AdbcLoadDriver</span></span></span><span class="sig-paren">(</sp [...] <dd><p>Common entry point for drivers via the driver manager. </p> <p>The driver manager can fill in default implementations of some ADBC functions for drivers. Drivers must implement a minimum level of functionality for this to be possible, however, and some functions must be implemented by the driver.</p> <dl class="field-list simple"> @@ -351,7 +351,7 @@ <dl class="cpp function"> <dt class="sig sig-object cpp" id="_CPPv426AdbcLoadDriverFromInitFunc18AdbcDriverInitFunciPvP9AdbcError"> -<span id="_CPPv326AdbcLoadDriverFromInitFunc18AdbcDriverInitFunciPvP9AdbcError"></span><span id="_CPPv226AdbcLoadDriverFromInitFunc18AdbcDriverInitFunciPvP9AdbcError"></span><span id="AdbcLoadDriverFromInitFunc__AdbcDriverInitFunc.i.voidP.AdbcErrorP"></span><span class="target" id="adbc__driver__manager_8h_1aba554fa202582afaa545ac666da60a40"></span><a class="reference internal" href="adbc.html#_CPPv414AdbcStatusCode" title="AdbcStatusCode"><span class="n"><span class="pre">AdbcStatusCode [...] +<span id="_CPPv326AdbcLoadDriverFromInitFunc18AdbcDriverInitFunciPvP9AdbcError"></span><span id="_CPPv226AdbcLoadDriverFromInitFunc18AdbcDriverInitFunciPvP9AdbcError"></span><span id="AdbcLoadDriverFromInitFunc__AdbcDriverInitFunc.i.voidP.AdbcErrorP"></span><span class="target" id="adbc__driver__manager_8h_1aba554fa202582afaa545ac666da60a40"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span c [...] <dd><p>Common entry point for drivers via the driver manager. </p> <p>The driver manager can fill in default implementations of some ADBC functions for drivers. Drivers must implement a minimum level of functionality for this to be possible, however, and some functions must be implemented by the driver.</p> <dl class="field-list simple"> @@ -368,14 +368,14 @@ <dl class="cpp function"> <dt class="sig sig-object cpp" id="_CPPv436AdbcDriverManagerDatabaseSetInitFuncP12AdbcDatabase18AdbcDriverInitFuncP9AdbcError"> -<span id="_CPPv336AdbcDriverManagerDatabaseSetInitFuncP12AdbcDatabase18AdbcDriverInitFuncP9AdbcError"></span><span id="_CPPv236AdbcDriverManagerDatabaseSetInitFuncP12AdbcDatabase18AdbcDriverInitFuncP9AdbcError"></span><span id="AdbcDriverManagerDatabaseSetInitFunc__AdbcDatabaseP.AdbcDriverInitFunc.AdbcErrorP"></span><span class="target" id="adbc__driver__manager_8h_1ae09e277867757f5ca2bb8d997cf0164c"></span><a class="reference internal" href="adbc.html#_CPPv414AdbcStatusCode" title="Adbc [...] +<span id="_CPPv336AdbcDriverManagerDatabaseSetInitFuncP12AdbcDatabase18AdbcDriverInitFuncP9AdbcError"></span><span id="_CPPv236AdbcDriverManagerDatabaseSetInitFuncP12AdbcDatabase18AdbcDriverInitFuncP9AdbcError"></span><span id="AdbcDriverManagerDatabaseSetInitFunc__AdbcDatabaseP.AdbcDriverInitFunc.AdbcErrorP"></span><span class="target" id="adbc__driver__manager_8h_1ae09e277867757f5ca2bb8d997cf0164c"></span><span class="n"><span class="pre">AdbcStatusCode</span></span><span class="w"> </ [...] <dd><p>Set the AdbcDriverInitFunc to use. </p> <p>This is an extension to the ADBC API. The driver manager shims the AdbcDatabase* functions to allow you to specify the driver/entrypoint dynamically. This function lets you set the entrypoint explicitly, for applications that can dynamically load drivers on their own. </p> </dd></dl> <dl class="cpp function"> <dt class="sig sig-object cpp" id="_CPPv421AdbcStatusCodeMessage14AdbcStatusCode"> -<span id="_CPPv321AdbcStatusCodeMessage14AdbcStatusCode"></span><span id="_CPPv221AdbcStatusCodeMessage14AdbcStatusCode"></span><span id="AdbcStatusCodeMessage__AdbcStatusCode"></span><span class="target" id="adbc__driver__manager_8h_1a466f295eadd40ec5887d2d57bc85c144"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class= [...] +<span id="_CPPv321AdbcStatusCodeMessage14AdbcStatusCode"></span><span id="_CPPv221AdbcStatusCodeMessage14AdbcStatusCode"></span><span id="AdbcStatusCodeMessage__AdbcStatusCode"></span><span class="target" id="adbc__driver__manager_8h_1a466f295eadd40ec5887d2d57bc85c144"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class= [...] <dd><p>Get a human-friendly description of a status code. </p> </dd></dl> diff --git a/main/cpp/concurrency.html b/main/cpp/concurrency.html index 789a2abf..3f6481c9 100644 --- a/main/cpp/concurrency.html +++ b/main/cpp/concurrency.html @@ -346,7 +346,7 @@ AdbcConnection:</p> </pre></div> </div> <p>What happens if the client application calls -<a class="reference internal" href="api/adbc.html#_CPPv425AdbcStatementExecuteQueryP13AdbcStatementP16ArrowArrayStreamP7int64_tP9AdbcError" title="AdbcStatementExecuteQuery"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcStatementExecuteQuery()</span></code></a> on <code class="docutils literal notranslate"><span class="pre">stmt1</span></code>, then on <code class="docutils literal notranslate"><span class="pre">stmt2</span></code>, +<code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcStatementExecuteQuery()</span></code> on <code class="docutils literal notranslate"><span class="pre">stmt1</span></code>, then on <code class="docutils literal notranslate"><span class="pre">stmt2</span></code>, without reading the result set of <code class="docutils literal notranslate"><span class="pre">stmt1</span></code>? Some existing client libraries/protocols, like libpq, don’t support concurrent execution of queries from a single connection. So the driver would have to diff --git a/main/cpp/driver_manager.html b/main/cpp/driver_manager.html index a4addc63..334853f9 100644 --- a/main/cpp/driver_manager.html +++ b/main/cpp/driver_manager.html @@ -337,7 +337,7 @@ addition to the driver-specific connection parameters: <code class="docutils lit (optionally) <code class="docutils literal notranslate"><span class="pre">entrypoint</span></code>. <code class="docutils literal notranslate"><span class="pre">driver</span></code> must be the name of a library to load, or the path to a library to load. <code class="docutils literal notranslate"><span class="pre">entrypoint</span></code>, if provided, should be the name of the symbol that serves as the ADBC -entrypoint (see <a class="reference internal" href="api/adbc.html#_CPPv418AdbcDriverInitFunc" title="AdbcDriverInitFunc"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">AdbcDriverInitFunc</span></code></a>).</p> +entrypoint (see <code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">AdbcDriverInitFunc</span></code>).</p> <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cm">/* Ignoring error handling */</span> <span class="k">struct</span><span class="w"> </span><span class="nc">AdbcDatabase</span><span class="w"> </span><span class="n">database</span><span class="p">;</span> <span class="n">memset</span><span class="p">(</span><span class="o">&</span><span class="n">database</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="k">sizeof</span><span class="p">(</span><span class="n">database</span><span class="p">));</span> diff --git a/main/cpp/quickstart.html b/main/cpp/quickstart.html index c9159141..7d20a673 100644 --- a/main/cpp/quickstart.html +++ b/main/cpp/quickstart.html @@ -435,7 +435,7 @@ prepared and non-prepared (“ad-hoc”) queries.</p> <section id="executing-a-query"> <h3>Executing a Query<a class="headerlink" href="#executing-a-query" title="Permalink to this heading">#</a></h3> <p>We execute a query by setting the query on the statement, then -calling <a class="reference internal" href="api/adbc.html#_CPPv425AdbcStatementExecuteQueryP13AdbcStatementP16ArrowArrayStreamP7int64_tP9AdbcError" title="AdbcStatementExecuteQuery"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcStatementExecuteQuery()</span></code></a>. The results come +calling <code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcStatementExecuteQuery()</span></code>. The results come back through the <a class="reference external" href="https://arrow.apache.org/docs/format/CDataInterface.html">Arrow C Data Interface</a>.</p> <div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="linenos">147</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">ArrowArrayStream</span><span class="w"> </span><span class="n">stream</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{};</span> <span class="linenos">148</span><span class="w"> </span><span class="kt">int64_t</span><span class="w"> </span><span class="n">rows_affected</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">-1</span><span class="p">;</span> diff --git a/main/driver/flight_sql.html b/main/driver/flight_sql.html index f1e89027..14a2c4bb 100644 --- a/main/driver/flight_sql.html +++ b/main/driver/flight_sql.html @@ -511,7 +511,7 @@ of the partitions.</p> <section id="metadata"> <h3>Metadata<a class="headerlink" href="#metadata" title="Permalink to this heading">#</a></h3> <p>The driver currently will not populate column constraint info (foreign -keys, primary keys, etc.) in <a class="reference internal" href="../cpp/api/adbc.html#_CPPv424AdbcConnectionGetObjectsP14AdbcConnectioniPKcPKcPKcPPKcPKcP16ArrowArrayStreamP9AdbcError" title="AdbcConnectionGetObjects"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcConnectionGetObjects()</span></code></a>. +keys, primary keys, etc.) in <code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcConnectionGetObjects()</span></code>. Also, catalog filters are evaluated as simple string matches, not <code class="docutils literal notranslate"><span class="pre">LIKE</span></code>-style patterns.</p> </section> @@ -556,7 +556,7 @@ calls that implement bulk ingestion, or transaction support.</p> <p>The driver supports transactions. It will first check the server’s SqlInfo to determine whether this is supported. Otherwise, transaction-related ADBC APIs will return -<a class="reference internal" href="../cpp/api/adbc.html#c.ADBC_STATUS_NOT_IMPLEMENTED" title="ADBC_STATUS_NOT_IMPLEMENTED"><code class="xref c c-type docutils literal notranslate"><span class="pre">ADBC_STATUS_NOT_IMPLEMENTED</span></code></a>.</p> +<code class="xref c c-type docutils literal notranslate"><span class="pre">ADBC_STATUS_NOT_IMPLEMENTED</span></code>.</p> </section> </section> </section> diff --git a/main/driver/snowflake.html b/main/driver/snowflake.html index f3af04eb..58a2c865 100644 --- a/main/driver/snowflake.html +++ b/main/driver/snowflake.html @@ -568,7 +568,7 @@ to <code class="docutils literal notranslate"><span class="pre">true</span></cod </section> <section id="metadata"> <h3>Metadata<a class="headerlink" href="#metadata" title="Permalink to this heading">#</a></h3> -<p>When calling <a class="reference internal" href="../cpp/api/adbc.html#_CPPv428AdbcConnectionGetTableSchemaP14AdbcConnectionPKcPKcPKcP11ArrowSchemaP9AdbcError" title="AdbcConnectionGetTableSchema"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcConnectionGetTableSchema()</span></code></a>, the returned Arrow Schema +<p>When calling <code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcConnectionGetTableSchema()</span></code>, the returned Arrow Schema will contain metadata on each field:</p> <dl class="simple"> <dt><code class="docutils literal notranslate"><span class="pre">DATA_TYPE</span></code></dt><dd><p>This will be a string containing the raw Snowflake data type of this column</p> diff --git a/main/driver/status.html b/main/driver/status.html index a96d91f5..a550f086 100644 --- a/main/driver/status.html +++ b/main/driver/status.html @@ -378,12 +378,12 @@ <dl class="simple"> <dt>Bulk Ingestion</dt><dd><p>Does the driver support <a class="reference internal" href="../format/specification.html#specification-bulk-ingestion"><span class="std std-ref">bulk ingestion of data</span></a> (creating or appending to a database table from an Arrow table)?</p> </dd> -<dt>Database Metadata</dt><dd><p>Does the driver support functions like <a class="reference internal" href="../cpp/api/adbc.html#_CPPv424AdbcConnectionGetObjectsP14AdbcConnectioniPKcPKcPKcPPKcPKcP16ArrowArrayStreamP9AdbcError" title="AdbcConnectionGetObjects"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcConnectionGetObjects()</span></code></a> that get metadata about the database catalog, etc.?</p> +<dt>Database Metadata</dt><dd><p>Does the driver support functions like <code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcConnectionGetObjects()</span></code> that get metadata about the database catalog, etc.?</p> </dd> <dt>Parameterized Queries</dt><dd><p>Does the driver support binding query parameters?</p> </dd> <dt>Partitioned Data</dt><dd><p>Being able to read individual chunks of a (generally distributed) -result set (<a class="reference internal" href="../cpp/api/adbc.html#_CPPv430AdbcStatementExecutePartitionsP13AdbcStatementP11ArrowSchemaP14AdbcPartitionsP7int64_tP9AdbcError" title="AdbcStatementExecutePartitions"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcStatementExecutePartitions()</span></code></a>).</p> +result set (<code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcStatementExecutePartitions()</span></code>).</p> </dd> <dt>Prepared Statements</dt><dd><p>Does the driver support binding query parameters?</p> </dd> diff --git a/main/format/specification.html b/main/format/specification.html index 6c91a90c..2994b8bb 100644 --- a/main/format/specification.html +++ b/main/format/specification.html @@ -353,7 +353,7 @@ that is, queries take effect immediately upon execution. This can be disabled in favor of manual commit/rollback calls, but not all implementations will support this.</p> <ul class="simple"> -<li><p>C/C++: <a class="reference internal" href="../cpp/api/adbc.html#c.ADBC_CONNECTION_OPTION_AUTOCOMMIT" title="ADBC_CONNECTION_OPTION_AUTOCOMMIT"><code class="xref c c-macro docutils literal notranslate"><span class="pre">ADBC_CONNECTION_OPTION_AUTOCOMMIT</span></code></a></p></li> +<li><p>C/C++: <code class="xref c c-macro docutils literal notranslate"><span class="pre">ADBC_CONNECTION_OPTION_AUTOCOMMIT</span></code></p></li> <li><p>Go: <code class="docutils literal notranslate"><span class="pre">OptionKeyAutoCommit</span></code></p></li> <li><p>Java: <code class="docutils literal notranslate"><span class="pre">org.apache.arrow.adbc.core.AdbcConnection#setAutoCommit(boolean)</span></code></p></li> </ul> @@ -377,7 +377,7 @@ a database table. For databases which support it, this can avoid overheads from the typical bind-insert loop. Also, this (mostly) frees the user from knowing the right SQL syntax for their database.</p> <ul class="simple"> -<li><p>C/C++: <a class="reference internal" href="../cpp/api/adbc.html#c.ADBC_INGEST_OPTION_TARGET_TABLE" title="ADBC_INGEST_OPTION_TARGET_TABLE"><code class="xref c c-macro docutils literal notranslate"><span class="pre">ADBC_INGEST_OPTION_TARGET_TABLE</span></code></a> and related +<li><p>C/C++: <code class="xref c c-macro docutils literal notranslate"><span class="pre">ADBC_INGEST_OPTION_TARGET_TABLE</span></code> and related options.</p></li> <li><p>Go: <code class="docutils literal notranslate"><span class="pre">OptionKeyIngestTargetTable</span></code></p></li> <li><p>Java: <code class="docutils literal notranslate"><span class="pre">org.apache.arrow.adbc.core.AdbcConnection#bulkIngest(String,</span> <span class="pre">org.apache.arrow.adbc.core.BulkIngestMode)</span></code></p></li> @@ -391,7 +391,7 @@ RPC/Flight SQL.) Clients may take advantage of this to distribute computations on a result set across multiple threads, processes, or machines.</p> <ul class="simple"> -<li><p>C/C++: <a class="reference internal" href="../cpp/api/adbc.html#_CPPv430AdbcStatementExecutePartitionsP13AdbcStatementP11ArrowSchemaP14AdbcPartitionsP7int64_tP9AdbcError" title="AdbcStatementExecutePartitions"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcStatementExecutePartitions()</span></code></a></p></li> +<li><p>C/C++: <code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">AdbcStatementExecutePartitions()</span></code></p></li> <li><p>Go: <code class="docutils literal notranslate"><span class="pre">Statement.ExecutePartitions</span></code></p></li> <li><p>Java: <code class="docutils literal notranslate"><span class="pre">org.apache.arrow.adbc.core.AdbcStatement#executePartitioned()</span></code></p></li> </ul> diff --git a/main/format/versioning.html b/main/format/versioning.html index 2db94470..0b593df0 100644 --- a/main/format/versioning.html +++ b/main/format/versioning.html @@ -331,7 +331,7 @@ instead use free functions, making it easy to add new functions.</p></li> <p>Of course, we can never add/remove/change struct members, and we can never change the signatures of existing functions.</p> <p>The main point of concern is compatibility of <a class="reference internal" href="../cpp/api/adbc.html#_CPPv410AdbcDriver" title="AdbcDriver"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">AdbcDriver</span></code></a>.</p> -<p>The driver entrypoint, <a class="reference internal" href="../cpp/api/adbc.html#_CPPv418AdbcDriverInitFunc" title="AdbcDriverInitFunc"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">AdbcDriverInitFunc</span></code></a>, is given a +<p>The driver entrypoint, <code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">AdbcDriverInitFunc</span></code>, is given a version and a pointer to a table of function pointers to initialize. The type of the table will depend on the version; when a new version of ADBC is accepted, then a new table of function pointers will be @@ -341,7 +341,7 @@ add a new ADBC version, the following scenarios are possible:</p> <li><p>An updated client application uses an old driver library. The client will pass a <cite>version</cite> field greater than what the driver recognizes, so the driver will return -<a class="reference internal" href="../cpp/api/adbc.html#c.ADBC_STATUS_NOT_IMPLEMENTED" title="ADBC_STATUS_NOT_IMPLEMENTED"><code class="xref c c-type docutils literal notranslate"><span class="pre">ADBC_STATUS_NOT_IMPLEMENTED</span></code></a> and the client can decide +<code class="xref c c-type docutils literal notranslate"><span class="pre">ADBC_STATUS_NOT_IMPLEMENTED</span></code> and the client can decide whether to abort or retry with an older version.</p></li> <li><p>An old client application uses an updated driver library. The client will pass a <code class="docutils literal notranslate"><span class="pre">version</span></code> lower than what the driver diff --git a/main/genindex.html b/main/genindex.html index ce7efc51..b2b58950 100644 --- a/main/genindex.html +++ b/main/genindex.html @@ -322,12 +322,6 @@ <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Connection.adbc_clone">adbc_clone() (adbc_driver_manager.dbapi.Connection method)</a> </li> <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Connection.adbc_connection">adbc_connection (adbc_driver_manager.dbapi.Connection property)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_CONNECTION_OPTION_AUTOCOMMIT">ADBC_CONNECTION_OPTION_AUTOCOMMIT (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_CONNECTION_OPTION_ISOLATION_LEVEL">ADBC_CONNECTION_OPTION_ISOLATION_LEVEL (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_CONNECTION_OPTION_READ_ONLY">ADBC_CONNECTION_OPTION_READ_ONLY (C macro)</a> </li> <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Connection.adbc_database">adbc_database (adbc_driver_manager.dbapi.Connection property)</a> </li> @@ -406,94 +400,14 @@ <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Connection.adbc_get_table_schema">adbc_get_table_schema() (adbc_driver_manager.dbapi.Connection method)</a> </li> <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Connection.adbc_get_table_types">adbc_get_table_types() (adbc_driver_manager.dbapi.Connection method)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_INFO_DRIVER_ARROW_VERSION">ADBC_INFO_DRIVER_ARROW_VERSION (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_INFO_DRIVER_NAME">ADBC_INFO_DRIVER_NAME (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_INFO_DRIVER_VERSION">ADBC_INFO_DRIVER_VERSION (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_INFO_VENDOR_ARROW_VERSION">ADBC_INFO_VENDOR_ARROW_VERSION (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_INFO_VENDOR_NAME">ADBC_INFO_VENDOR_NAME (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_INFO_VENDOR_VERSION">ADBC_INFO_VENDOR_VERSION (C macro)</a> </li> <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Cursor.adbc_ingest">adbc_ingest() (adbc_driver_manager.dbapi.Cursor method)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_INGEST_OPTION_MODE">ADBC_INGEST_OPTION_MODE (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_INGEST_OPTION_MODE_APPEND">ADBC_INGEST_OPTION_MODE_APPEND (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_INGEST_OPTION_MODE_CREATE">ADBC_INGEST_OPTION_MODE_CREATE (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_INGEST_OPTION_TARGET_TABLE">ADBC_INGEST_OPTION_TARGET_TABLE (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OBJECT_DEPTH_ALL">ADBC_OBJECT_DEPTH_ALL (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OBJECT_DEPTH_CATALOGS">ADBC_OBJECT_DEPTH_CATALOGS (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OBJECT_DEPTH_COLUMNS">ADBC_OBJECT_DEPTH_COLUMNS (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OBJECT_DEPTH_DB_SCHEMAS">ADBC_OBJECT_DEPTH_DB_SCHEMAS (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OBJECT_DEPTH_TABLES">ADBC_OBJECT_DEPTH_TABLES (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OPTION_ISOLATION_LEVEL_DEFAULT">ADBC_OPTION_ISOLATION_LEVEL_DEFAULT (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OPTION_ISOLATION_LEVEL_LINEARIZABLE">ADBC_OPTION_ISOLATION_LEVEL_LINEARIZABLE (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OPTION_ISOLATION_LEVEL_READ_COMMITTED">ADBC_OPTION_ISOLATION_LEVEL_READ_COMMITTED (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OPTION_ISOLATION_LEVEL_READ_UNCOMMITTED">ADBC_OPTION_ISOLATION_LEVEL_READ_UNCOMMITTED (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OPTION_ISOLATION_LEVEL_REPEATABLE_READ">ADBC_OPTION_ISOLATION_LEVEL_REPEATABLE_READ (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OPTION_ISOLATION_LEVEL_SERIALIZABLE">ADBC_OPTION_ISOLATION_LEVEL_SERIALIZABLE (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OPTION_ISOLATION_LEVEL_SNAPSHOT">ADBC_OPTION_ISOLATION_LEVEL_SNAPSHOT (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OPTION_VALUE_DISABLED">ADBC_OPTION_VALUE_DISABLED (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_OPTION_VALUE_ENABLED">ADBC_OPTION_VALUE_ENABLED (C macro)</a> </li> <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Cursor.adbc_prepare">adbc_prepare() (adbc_driver_manager.dbapi.Cursor method)</a> </li> <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Cursor.adbc_read_partition">adbc_read_partition() (adbc_driver_manager.dbapi.Cursor method)</a> </li> <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.dbapi.Cursor.adbc_statement">adbc_statement (adbc_driver_manager.dbapi.Cursor property)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_ALREADY_EXISTS">ADBC_STATUS_ALREADY_EXISTS (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_CANCELLED">ADBC_STATUS_CANCELLED (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_INTEGRITY">ADBC_STATUS_INTEGRITY (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_INTERNAL">ADBC_STATUS_INTERNAL (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_INVALID_ARGUMENT">ADBC_STATUS_INVALID_ARGUMENT (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_INVALID_DATA">ADBC_STATUS_INVALID_DATA (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_INVALID_STATE">ADBC_STATUS_INVALID_STATE (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_IO">ADBC_STATUS_IO (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_NOT_FOUND">ADBC_STATUS_NOT_FOUND (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_NOT_IMPLEMENTED">ADBC_STATUS_NOT_IMPLEMENTED (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_OK">ADBC_STATUS_OK (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_TIMEOUT">ADBC_STATUS_TIMEOUT (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_UNAUTHENTICATED">ADBC_STATUS_UNAUTHENTICATED (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_UNAUTHORIZED">ADBC_STATUS_UNAUTHORIZED (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_STATUS_UNKNOWN">ADBC_STATUS_UNKNOWN (C macro)</a> -</li> - <li><a href="cpp/api/adbc.html#c.ADBC_VERSION_1_0_0">ADBC_VERSION_1_0_0 (C macro)</a> </li> <li><a href="cpp/api/adbc.html#_CPPv414AdbcConnection">AdbcConnection (C++ struct)</a> @@ -504,30 +418,6 @@ <li><a href="cpp/api/adbc.html#_CPPv4N14AdbcConnection12private_dataE">AdbcConnection::private_data (C++ member)</a> </li> <li><a href="cpp/api/adbc.html#_CPPv4N14AdbcConnection14private_driverE">AdbcConnection::private_driver (C++ member)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv420AdbcConnectionCommitP14AdbcConnectionP9AdbcError">AdbcConnectionCommit (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv421AdbcConnectionGetInfoP14AdbcConnectionP8uint32_t6size_tP16ArrowArrayStreamP9AdbcError">AdbcConnectionGetInfo (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv424AdbcConnectionGetObjectsP14AdbcConnectioniPKcPKcPKcPPKcPKcP16ArrowArrayStreamP9AdbcError">AdbcConnectionGetObjects (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv428AdbcConnectionGetTableSchemaP14AdbcConnectionPKcPKcPKcP11ArrowSchemaP9AdbcError">AdbcConnectionGetTableSchema (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv427AdbcConnectionGetTableTypesP14AdbcConnectionP16ArrowArrayStreamP9AdbcError">AdbcConnectionGetTableTypes (C++ function)</a> -</li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="cpp/api/adbc.html#_CPPv418AdbcConnectionInitP14AdbcConnectionP12AdbcDatabaseP9AdbcError">AdbcConnectionInit (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv417AdbcConnectionNewP14AdbcConnectionP9AdbcError">AdbcConnectionNew (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv427AdbcConnectionReadPartitionP14AdbcConnectionPK7uint8_t6size_tP16ArrowArrayStreamP9AdbcError">AdbcConnectionReadPartition (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv421AdbcConnectionReleaseP14AdbcConnectionP9AdbcError">AdbcConnectionRelease (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv422AdbcConnectionRollbackP14AdbcConnectionP9AdbcError">AdbcConnectionRollback (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv423AdbcConnectionSetOptionP14AdbcConnectionPKcPKcP9AdbcError">AdbcConnectionSetOption (C++ function)</a> </li> <li><a href="cpp/api/adbc.html#_CPPv412AdbcDatabase">AdbcDatabase (C++ struct)</a> @@ -538,14 +428,6 @@ <li><a href="cpp/api/adbc.html#_CPPv4N12AdbcDatabase12private_dataE">AdbcDatabase::private_data (C++ member)</a> </li> <li><a href="cpp/api/adbc.html#_CPPv4N12AdbcDatabase14private_driverE">AdbcDatabase::private_driver (C++ member)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv416AdbcDatabaseInitP12AdbcDatabaseP9AdbcError">AdbcDatabaseInit (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv415AdbcDatabaseNewP12AdbcDatabaseP9AdbcError">AdbcDatabaseNew (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv419AdbcDatabaseReleaseP12AdbcDatabaseP9AdbcError">AdbcDatabaseRelease (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv421AdbcDatabaseSetOptionP12AdbcDatabasePKcPKcP9AdbcError">AdbcDatabaseSetOption (C++ function)</a> </li> <li><a href="cpp/api/adbc.html#_CPPv410AdbcDriver">AdbcDriver (C++ struct)</a> </li> @@ -563,6 +445,8 @@ </li> <li><a href="cpp/api/adbc.html#_CPPv4N10AdbcDriver13ConnectionNewE">AdbcDriver::ConnectionNew (C++ member)</a> </li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> <li><a href="cpp/api/adbc.html#_CPPv4N10AdbcDriver23ConnectionReadPartitionE">AdbcDriver::ConnectionReadPartition (C++ member)</a> </li> <li><a href="cpp/api/adbc.html#_CPPv4N10AdbcDriver17ConnectionReleaseE">AdbcDriver::ConnectionRelease (C++ member)</a> @@ -606,8 +490,6 @@ <li><a href="cpp/api/adbc.html#_CPPv4N10AdbcDriver20StatementSetSqlQueryE">AdbcDriver::StatementSetSqlQuery (C++ member)</a> </li> <li><a href="cpp/api/adbc.html#_CPPv4N10AdbcDriver25StatementSetSubstraitPlanE">AdbcDriver::StatementSetSubstraitPlan (C++ member)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv418AdbcDriverInitFunc">AdbcDriverInitFunc (C++ type)</a> </li> <li><a href="cpp/api/adbc_driver_manager.html#_CPPv436AdbcDriverManagerDatabaseSetInitFuncP12AdbcDatabase18AdbcDriverInitFuncP9AdbcError">AdbcDriverManagerDatabaseSetInitFunc (C++ function)</a> </li> @@ -647,34 +529,8 @@ </li> <li><a href="cpp/api/adbc.html#_CPPv4N13AdbcStatement14private_driverE">AdbcStatement::private_driver (C++ member)</a> </li> - <li><a href="cpp/api/adbc.html#_CPPv417AdbcStatementBindP13AdbcStatementP10ArrowArrayP11ArrowSchemaP9AdbcError">AdbcStatementBind (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv423AdbcStatementBindStreamP13AdbcStatementP16ArrowArrayStreamP9AdbcError">AdbcStatementBindStream (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv430AdbcStatementExecutePartitionsP13AdbcStatementP11ArrowSchemaP14AdbcPartitionsP7int64_tP9AdbcError">AdbcStatementExecutePartitions (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv425AdbcStatementExecuteQueryP13AdbcStatementP16ArrowArrayStreamP7int64_tP9AdbcError">AdbcStatementExecuteQuery (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv431AdbcStatementGetParameterSchemaP13AdbcStatementP11ArrowSchemaP9AdbcError">AdbcStatementGetParameterSchema (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv416AdbcStatementNewP14AdbcConnectionP13AdbcStatementP9AdbcError">AdbcStatementNew (C++ function)</a> + <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.AdbcStatusCode">AdbcStatusCode (class in adbc_driver_manager)</a> </li> - <li><a href="cpp/api/adbc.html#_CPPv420AdbcStatementPrepareP13AdbcStatementP9AdbcError">AdbcStatementPrepare (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv420AdbcStatementReleaseP13AdbcStatementP9AdbcError">AdbcStatementRelease (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv422AdbcStatementSetOptionP13AdbcStatementPKcPKcP9AdbcError">AdbcStatementSetOption (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv424AdbcStatementSetSqlQueryP13AdbcStatementPKcP9AdbcError">AdbcStatementSetSqlQuery (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv429AdbcStatementSetSubstraitPlanP13AdbcStatementPK7uint8_t6size_tP9AdbcError">AdbcStatementSetSubstraitPlan (C++ function)</a> -</li> - <li><a href="cpp/api/adbc.html#_CPPv414AdbcStatusCode">AdbcStatusCode (C++ type)</a> - - <ul> - <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.AdbcStatusCode">(class in adbc_driver_manager)</a> -</li> - </ul></li> <li><a href="cpp/api/adbc_driver_manager.html#_CPPv421AdbcStatusCodeMessage14AdbcStatusCode">AdbcStatusCodeMessage (C++ function)</a> </li> <li><a href="python/api/adbc_driver_manager.html#adbc_driver_manager.ArrowArrayHandle.address">address (adbc_driver_manager.ArrowArrayHandle attribute)</a> diff --git a/main/objects.inv b/main/objects.inv index f0742d14..34647c03 100644 Binary files a/main/objects.inv and b/main/objects.inv differ diff --git a/main/python/driver_manager.html b/main/python/driver_manager.html index 8ae32eb6..a75160f7 100644 --- a/main/python/driver_manager.html +++ b/main/python/driver_manager.html @@ -341,7 +341,7 @@ standard.</p> (optionally) <code class="docutils literal notranslate"><span class="pre">entrypoint</span></code>. <code class="docutils literal notranslate"><span class="pre">driver</span></code> must be the name of a library to load, or the path to a library to load. <code class="docutils literal notranslate"><span class="pre">entrypoint</span></code>, if provided, should be the name of the symbol that serves as the ADBC -entrypoint (see <a class="reference internal" href="../cpp/api/adbc.html#_CPPv418AdbcDriverInitFunc" title="AdbcDriverInitFunc"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">AdbcDriverInitFunc</span></code></a>). Then, create a +entrypoint (see <code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">AdbcDriverInitFunc</span></code>). Then, create a <a class="reference internal" href="api/adbc_driver_manager.html#adbc_driver_manager.AdbcConnection" title="adbc_driver_manager.AdbcConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">AdbcConnection</span></code></a>.</p> <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">adbc_driver_manager</span> <span class="k">with</span> <span class="n">adbc_driver_manager</span><span class="o">.</span><span class="n">AdbcDatabase</span><span class="p">(</span><span class="n">driver</span><span class="o">=</span><span class="s2">"adbc_driver_sqlite"</span><span class="p">)</span> <span class="k">as</span> <span class="n">db</span><span class="p">:</span> diff --git a/main/searchindex.js b/main/searchindex.js index c68e5759..c0524ad3 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["cpp/api/adbc", "cpp/api/adbc_driver_manager", "cpp/api/index", "cpp/concurrency", "cpp/driver_manager", "cpp/index", "cpp/quickstart", "development/contributing", "development/nightly", "development/releasing", "driver/flight_sql", "driver/installation", "driver/jdbc", "driver/postgresql", "driver/snowflake", "driver/sqlite", "driver/status", "faq", "format/comparison", "format/specification", "format/versioning", "index", "java/index", "python/api/adbc_dri [...] \ No newline at end of file +Search.setIndex({"docnames": ["cpp/api/adbc", "cpp/api/adbc_driver_manager", "cpp/api/index", "cpp/concurrency", "cpp/driver_manager", "cpp/index", "cpp/quickstart", "development/contributing", "development/nightly", "development/releasing", "driver/flight_sql", "driver/installation", "driver/jdbc", "driver/postgresql", "driver/snowflake", "driver/sqlite", "driver/status", "faq", "format/comparison", "format/specification", "format/versioning", "index", "java/index", "python/api/adbc_dri [...] \ No newline at end of file