chore: import validation suite

Author: lidavidm

.gitignore

@@ -0,0 +1,221 @@
+# Copyright (c) 2025 Columnar Technologies, Inc.
+#
+# Licensed 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.
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

.pre-commit-config.yaml

@@ -0,0 +1,48 @@
+# Copyright (c) 2025 Columnar Technologies, Inc.
+#
+# Licensed 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.
+
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: 8a948e557ca98afa9489998ad0b85515964df9c4  # v0.12.0
+  hooks:
+    - id: ruff-check
+      name: "ruff check (isort)"
+      args: ["--select", "I", "--fix"]
+    - id: ruff-check
+      args: ["--fix"]
+    - id: ruff-format
+
+- repo: https://github.com/codespell-project/codespell
+  rev: 63c8f8312b7559622c0d82815639671ae42132ac  # v2.4.1
+  hooks:
+  - id: codespell
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: cef0300fd0fc4d2a87a85fa2093c6b283ea36f4b  # v5.0.0
+  hooks:
+  - id: check-added-large-files
+  - id: check-case-conflict
+  - id: check-executables-have-shebangs
+  - id: check-yaml
+  - id: detect-private-key
+  - id: end-of-file-fixer
+  - id: mixed-line-ending
+    args: [--fix=lf]
+    exclude: '\.bat$'
+  - id: trailing-whitespace
+
+- repo: git@github.com:adbc-drivers/dev
+  rev: f5779f2109f177f7da6394d3427589a3a84eb521
+  hooks:
+  - id: rat

.rat-excludes

@@ -0,0 +1,16 @@
+# Copyright (c) 2025 Columnar Technologies, Inc.
+#
+# Licensed 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.
+
+adbc_drivers_validation/queries/*/*.json
+adbc_drivers_validation/queries/*/*.sql

README.markdown

@@ -0,0 +1,84 @@
+<!--
+  Copyright (c) 2025 Columnar Technologies, Inc.
+
+  Licensed 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.
+-->
+
+# Driver Validation Suite
+
+## Adding New Tests
+
+The validation suite essentially runs a bunch of SQL queries against each
+driver.  The queries are tagged with various bits of metadata that are used to
+generate documentation.
+
+The queries live under `queries/base`.  They are somewhat subcategorized, but
+this is arbitrary and not important to the test runner.  A single query is all
+the files in the same directory with the same filename (less extensions).  The
+type of query, and hence what kind of test results, depends on which files are
+present.
+
+All queries have an optional `query.toml` file defining various metadata:
+
+- `hide` (`bool`) - if `true`, don't run this query (for this driver)
+- `sort-keys` (`list[tuple[str, 'ascending' | 'descending']]`) - if present,
+  sort the result set by these columns before comparison
+- `tags` table:
+  - `caveats` (`list[str]`) - if present, a list of footnotes to add to the
+    user documentation (e.g. to explain why something is only partially
+    supported)
+  - `partial-support` (`bool`) - if present, indicate in the user
+    documentation that something is only partially supported
+  - `sql-type-name` (`str`) - the name of the SQL type being tested (to
+    display in the user documentation)
+
+A `SELECT` query just tests running a query and checking the result.  It
+consists of:
+
+- `query.sql` - the query to run
+- `query.schema.json` - the schema of the result set
+- `query.json` - the data of the result set (in JSON Lines)
+- `query.setup.sql` (optional) - a query to run before the main query (e.g. to
+  create any tables required)
+- `query.bind.json` (optional) - data to insert via executing a query with
+  bind parameters (in JSON Lines)
+- `query.bind.schema.json` (optional) - the schema of the bind data
+- `query.bind.sql` (optional) - the query that is executed for bind data.  It
+  should always use `$1` style placeholders, which will be replaced at runtime
+  with database-specific placeholders
+
+A schema query tests getting the schema of the result set of a query without
+actually running it.  It consists of:
+
+- `query.sql`
+- `query.schema.json`
+
+An ingest query tests using bulk ingestion to load Arrow data, then querying
+the result table.  It consists of:
+
+- `query.input.schema.json` - the schema of the data to insert
+- `query.input.json` - the data to insert
+- `query.schema.json` (optional) - the schema of the result set (by default it
+  is assumed to be the same as the input)
+- `query.json` (optional) - the data of the result set (in JSON Lines) (by
+  default it is assumed to be the same as the input)
+
+### Overriding Tests with Driver-Specific Tests
+
+Often a driver needs specific changes to a test case, e.g. because it picks a
+different return type.  Also, drivers may support extra features that need
+specific test cases, or may not support a feature and need to skip a test
+case.  These can be added under a directory specified by the driver quirks.
+Instead of duplicating the full test case, as long as a file is present at the
+same relative path, it will be used to override that specific part of that
+test case for that driver.

adbc_drivers_validation/__init__.py

@@ -0,0 +1,13 @@
+# Copyright (c) 2025 Columnar Technologies, Inc.
+#
+# Licensed 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.