Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/source/python/api/adbc_driver_bigquery.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. Licensed to the Apache Software Foundation (ASF) under one
.. or more contributor license agreements. See the NOTICE file
.. distributed with this work for additional information
.. regarding copyright ownership. The ASF licenses this file
.. to you under the Apache License, Version 2.0 (the
.. "License"); you may not use this file except in compliance
.. with the License. You may obtain a copy of the License at
..
.. http://www.apache.org/licenses/LICENSE-2.0
..
.. Unless required by applicable law or agreed to in writing,
.. software distributed under the License is distributed on an
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
.. KIND, either express or implied. See the License for the
.. specific language governing permissions and limitations
.. under the License.

.. default-domain:: py

=========================
``adbc_driver_bigquery``
=========================

Low-Level API
=============

.. automodule:: adbc_driver_bigquery
:members:
:undoc-members:

DBAPI 2.0 API
=============

.. automodule:: adbc_driver_bigquery.dbapi

.. autofunction:: adbc_driver_bigquery.dbapi.connect
36 changes: 36 additions & 0 deletions docs/source/python/api/adbc_driver_snowflake.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. Licensed to the Apache Software Foundation (ASF) under one
.. or more contributor license agreements. See the NOTICE file
.. distributed with this work for additional information
.. regarding copyright ownership. The ASF licenses this file
.. to you under the Apache License, Version 2.0 (the
.. "License"); you may not use this file except in compliance
.. with the License. You may obtain a copy of the License at
..
.. http://www.apache.org/licenses/LICENSE-2.0
..
.. Unless required by applicable law or agreed to in writing,
.. software distributed under the License is distributed on an
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
.. KIND, either express or implied. See the License for the
.. specific language governing permissions and limitations
.. under the License.

.. default-domain:: py

=========================
``adbc_driver_snowflake``
=========================

Low-Level API
=============

.. automodule:: adbc_driver_snowflake
:members:
:undoc-members:

DBAPI 2.0 API
=============

.. automodule:: adbc_driver_snowflake.dbapi

.. autofunction:: adbc_driver_snowflake.dbapi.connect
2 changes: 2 additions & 0 deletions docs/source/python/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ Python API Reference

adbc_driver_manager

adbc_driver_bigquery
adbc_driver_flightsql
adbc_driver_postgresql
adbc_driver_snowflake
adbc_driver_sqlite
99 changes: 53 additions & 46 deletions python/adbc_driver_bigquery/adbc_driver_bigquery/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,80 +96,87 @@ class StatementOptions(enum.Enum):

#: CREATE_DISPOSITION specifies the circumstances under which the
#: destination table will be created.
#: The default is `"CREATE_IF_NEEDED"`.
#: The default is ``CREATE_IF_NEEDED``.
#:
#: The following values are supported:
#: - "CREATE_IF_NEEDED": will create the table if it does not already exist
#: Tables are created atomically on successful completion of a job.
#: - "CREATE_NEVER": ensures the table must already exist and will not be
#: automatically created.
#:
#: * ``CREATE_IF_NEEDED``:
#: Will create the table if it does not already exist.
#: Tables are created atomically on successful completion of a job.
#: * ``CREATE_NEVER``:
#: Ensures the table must already exist and will not be automatically created.
CREATE_DISPOSITION = "adbc.bigquery.sql.query.create_disposition"

#: WRITE_DISPOSITION specifies how existing data in the destination
#: table is treated.
#: The default is `"WRITE_EMPTY"`.
#: The default is ``WRITE_EMPTY``.
#:
#: The following values are supported:
#: - "WRITE_APPEND": will append to any existing data in the destination
#: table.
#: Data is appended atomically on successful completion of a job.
#: - "WRITE_TRUNCATE": overrides the existing data in the destination table
#: Data is overwritten atomically on successful completion of a job.
#: - "WRITE_EMPTY": fails writes if the destination table already contains
#: data.
#:
#: * ``WRITE_APPEND``:
#: Will append to any existing data in the destination table.
#: Data is appended atomically on successful completion of a job.
#: * ``WRITE_TRUNCATE``:
#: Overrides the existing data in the destination table.
#: Data is overwritten atomically on successful completion of a job.
#: * ``WRITE_EMPTY``:
#: Fails writes if the destination table already contains data.
WRITE_DISPOSITION = "adbc.bigquery.sql.query.write_disposition"

#: DISABLE_QUERY_CACHE prevents results being fetched from the query cache.
#: If this field is false, results are fetched from the cache if they are
#: available.
#: The query cache is a best-effort cache that is flushed whenever tables
#: in the query are modified.
#: Cached results are only available when TableID is unspecified in the
#: query's destination Table.
#: For more information, see
#:
#: The query cache is a best-effort cache that is flushed whenever tables in
#: the query are modified. Cached results are only available when TableID is
#: unspecified in the query's destination Table.
#:
#: For more information, see:
#: https://cloud.google.com/bigquery/querying-data#querycaching
DISABLE_QUERY_CACHE = "adbc.bigquery.sql.query.disable_query_cache"

#: DISABLE_FLATTEN_RESULTS prevents results being flattened.
#: If this field is false, results from nested and repeated fields are
#: flattened.
#: DISABLE_FLATTEN_RESULTS implies ALLOW_LARGE_RESULTS
#: For more information, see
#:
#: DISABLE_FLATTEN_RESULTS implies ALLOW_LARGE_RESULTS.
#:
#: For more information, see:
#: https://cloud.google.com/bigquery/docs/data#nested
DISABLE_FLATTEN_RESULTS = "adbc.bigquery.sql.query.disable_flatten_results"

#: ALLOW_LARGE_RESULTS allows the query to produce arbitrarily large
#: result tables.
#: The destination must be a table.
#: When using this option, queries will take longer to execute, even if
#: the result set is small.
#: For additional limitations, see
#: ALLOW_LARGE_RESULTS allows the query to produce arbitrarily large result
#: tables. The destination must be a table. When using this option, queries
#: will take longer to execute, even if the result set is small.
#:
#: For additional limitations, see:
#: https://cloud.google.com/bigquery/querying-data#largequeryresults
ALLOW_LARGE_RESULTS = "adbc.bigquery.sql.query.allow_large_results"

#: PRIORITY specifies the priority with which to schedule the query.
#: The default priority is `"INTERACTIVE"`.
#: For more information, see
#: The default priority is ``INTERACTIVE``.
#:
#: For more information, see:
#: https://cloud.google.com/bigquery/querying-data#batchqueries
#:
#: The following values are supported:
#: - "BATCH": BatchPriority specifies that the query should be scheduled
#: with the batch priority. BigQuery queues each batch query on your
#: behalf, and starts the query as soon as idle resources are available,
#: usually within a few minutes. If BigQuery hasn't started the query
#: within 24 hours, BigQuery changes the job priority to interactive.
#: Batch queries don't count towards your concurrent rate limit, which
#: can make it easier to start many queries at once.
#:
#: More information can be found at
#: https://cloud.google.com/bigquery/docs/running-queries#batchqueries.
#:
#: - "INTERACTIVE": specifies that the query should be scheduled with
#: interactive priority, which means that the query is executed as soon
#: as possible. Interactive queries count towards your concurrent rate
#: limit and your daily limit. It is the default priority with which
#: queries get executed.
#:
#: More information can be found at
#: https://cloud.google.com/bigquery/docs/running-queries#queries.
#: * ``BATCH``:
#: BatchPriority specifies that the query should be scheduled with the
#: batch priority. BigQuery queues each batch query on your behalf, and
#: starts the query as soon as idle resources are available, usually
#: within a few minutes. If BigQuery hasn't started the query within 24
#: hours, BigQuery changes the job priority to interactive. Batch queries
#: don't count towards your concurrent rate limit, which can make it
#: easier to start many queries at once. More information can be found at:
#: https://cloud.google.com/bigquery/docs/running-queries#batchqueries
#: * ``INTERACTIVE``:
#: Specifies that the query should be scheduled with interactive priority,
#: which means that the query is executed as soon as possible. Interactive
#: queries count towards your concurrent rate limit and your daily limit.
#: It is the default priority with which queries get executed. More
#: information can be found at:
#: https://cloud.google.com/bigquery/docs/running-queries#queries
PRIORITY = "adbc.bigquery.sql.query.priority"

#: MAX_BILLING_TIER sets the maximum billing tier for a Query.
Expand Down
Loading