-
Notifications
You must be signed in to change notification settings - Fork 107
feat(catalog): add SQL catalog #693
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| # 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. | ||
|
|
||
| name: SQL Catalog Tests | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - '**' | ||
| - '!dependabot/**' | ||
| tags: | ||
| - '**' | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, ready_for_review] | ||
|
|
||
| concurrency: | ||
| group: ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }} | ||
| cancel-in-progress: true | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| env: | ||
| ICEBERG_HOME: /tmp/iceberg | ||
|
|
||
| jobs: | ||
| sql-catalog: | ||
| if: ${{ github.event_name != 'pull_request' || github.event.pull_request.draft == false }} | ||
| name: SQL Catalog (${{ matrix.title }}) | ||
| runs-on: ${{ matrix.runs-on }} | ||
| timeout-minutes: 45 | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| include: | ||
| - title: AMD64 Ubuntu 24.04 | ||
| runs-on: ubuntu-24.04 | ||
| CC: gcc-14 | ||
| CXX: g++-14 | ||
| cmake_build_type: Debug | ||
| cmake_extra_args: "" | ||
| - title: AArch64 macOS 26 | ||
| runs-on: macos-26 | ||
| cmake_build_type: Debug | ||
| cmake_extra_args: "" | ||
| - title: AMD64 Windows 2025 | ||
| runs-on: windows-2025 | ||
| cmake_build_type: Release | ||
| cmake_extra_args: -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake | ||
| steps: | ||
| - name: Checkout iceberg-cpp | ||
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
| with: | ||
| persist-credentials: false | ||
| - name: Set up MSVC Developer Command Prompt | ||
| if: ${{ startsWith(matrix.runs-on, 'windows') }} | ||
| uses: ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756 # v1.13.0 | ||
| with: | ||
| arch: x64 | ||
| - name: Install dependencies on Ubuntu | ||
| if: ${{ startsWith(matrix.runs-on, 'ubuntu') }} | ||
| shell: bash | ||
| run: sudo apt-get update && sudo apt-get install -y libsqlite3-dev | ||
| - name: Set Ubuntu Compilers | ||
| if: ${{ startsWith(matrix.runs-on, 'ubuntu') }} | ||
| run: | | ||
| echo "CC=${{ matrix.CC }}" >> $GITHUB_ENV | ||
| echo "CXX=${{ matrix.CXX }}" >> $GITHUB_ENV | ||
| - name: Install dependencies on macOS | ||
| if: ${{ startsWith(matrix.runs-on, 'macos') }} | ||
| shell: bash | ||
| run: | | ||
| brew install fmt | ||
| echo "CMAKE_PREFIX_PATH=$(brew --prefix fmt):${CMAKE_PREFIX_PATH:-}" >> "${GITHUB_ENV}" | ||
| - name: Install dependencies on Windows | ||
| if: ${{ startsWith(matrix.runs-on, 'windows') }} | ||
| shell: pwsh | ||
| run: | | ||
| vcpkg install zlib:x64-windows nlohmann-json:x64-windows nanoarrow:x64-windows roaring:x64-windows sqlite3:x64-windows | ||
| - name: Configure Iceberg | ||
| shell: bash | ||
| run: | | ||
| cmake -S . -B build -G Ninja \ | ||
| -DCMAKE_INSTALL_PREFIX="${ICEBERG_HOME}" \ | ||
| -DCMAKE_BUILD_TYPE=${{ matrix.cmake_build_type }} \ | ||
| -DICEBERG_BUILD_STATIC=ON \ | ||
| -DICEBERG_BUILD_SHARED=ON \ | ||
| -DICEBERG_BUILD_REST=OFF \ | ||
| -DICEBERG_BUILD_SQL_CATALOG=ON \ | ||
| -DICEBERG_SQL_SQLITE=ON \ | ||
| ${{ matrix.cmake_extra_args }} | ||
| - name: Build SQL catalog tests | ||
| shell: bash | ||
| run: cmake --build build --target sql_catalog_test | ||
| - name: Run SQL catalog tests | ||
| shell: bash | ||
| run: ctest --test-dir build -R '^sql_catalog_test$' --output-on-failure -C ${{ matrix.cmake_build_type }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| <!-- | ||
| ~ 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. | ||
| --> | ||
|
|
||
| # SQL Catalog | ||
|
|
||
| `SqlCatalog` implements the Iceberg `Catalog` API on top of a relational | ||
| database. Its schema is compatible with the Apache Iceberg Java `JdbcCatalog` | ||
| and stores catalog rows in `iceberg_tables` and | ||
| `iceberg_namespace_properties`. | ||
|
|
||
| ## Build | ||
|
|
||
| The SQL catalog is currently available through the CMake build only. Meson does | ||
| not build or install it yet. | ||
|
|
||
| Enable the catalog at configure time: | ||
|
|
||
| ```bash | ||
| cmake -S . -B build -DICEBERG_BUILD_SQL_CATALOG=ON | ||
| ``` | ||
|
|
||
| Built-in connectors are optional: | ||
|
|
||
| | CMake option | Default | Native dependency | | ||
| |--------------|---------|-------------------| | ||
| | `ICEBERG_SQL_SQLITE` | `OFF` | SQLite3 | | ||
| | `ICEBERG_SQL_POSTGRESQL` | `OFF` | libpq | | ||
| | `ICEBERG_SQL_MYSQL` | `OFF` | libmysqlclient | | ||
|
|
||
| The built-in connectors use | ||
| [sqlpp23](https://github.com/rbock/sqlpp23), which is fetched by CMake when a | ||
| connector is enabled. Projects can also supply their own `CatalogStore` | ||
| implementation and disable all built-in connectors. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```cpp | ||
| #include "iceberg/catalog/sql/sql_catalog.h" | ||
|
|
||
| using iceberg::sql::SqlCatalog; | ||
| using iceberg::sql::SqlCatalogConfig; | ||
|
|
||
| SqlCatalogConfig config{ | ||
| .name = "prod", | ||
| .uri = "/var/lib/iceberg/catalog.db", | ||
| .warehouse_location = "s3://my-bucket/warehouse", | ||
| }; | ||
|
|
||
| auto catalog = SqlCatalog::MakeSqliteCatalog(config, file_io).value(); | ||
| ``` | ||
|
|
||
| Connector factories are always declared in the public headers. If a connector | ||
| was not built, its factory returns `ErrorKind::kNotSupported`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nice to enhance this in the future by enabling specific modules only when their paths are affected.