-
Notifications
You must be signed in to change notification settings - Fork 5.5k
[docs] Add documentation for file-based metastore #24511
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
steveburnett
merged 1 commit into
prestodb:master
from
steveburnett:steveburnett-file-based-hms
Feb 12, 2025
Merged
Changes from all commits
Commits
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
71 changes: 71 additions & 0 deletions
71
presto-docs/src/main/sphinx/connector/file-based-metastore.rst
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,71 @@ | ||
| ==================== | ||
| File-Based Metastore | ||
| ==================== | ||
|
|
||
| .. contents:: | ||
| :local: | ||
| :backlinks: none | ||
| :depth: 1 | ||
|
|
||
| Overview | ||
| ^^^^^^^^ | ||
|
|
||
| For testing or developing purposes, Presto can be configured to use a local | ||
| filesystem directory as a Hive Metastore. | ||
|
|
||
| The file-based metastore works only with the following connectors: | ||
|
|
||
| * :doc:`/connector/deltalake` | ||
| * :doc:`/connector/hive` | ||
| * :doc:`/connector/hudi` | ||
| * :doc:`/connector/iceberg` | ||
|
|
||
| Configuring a File-Based Metastore | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| 1. In ``etc/catalog/``, find the catalog properties file for the supported | ||
| connector. | ||
|
|
||
| 2. In the catalog properties file, set the following properties: | ||
|
|
||
| .. code-block:: none | ||
|
|
||
| hive.metastore=file | ||
| hive.metastore.catalog.dir=file:///<catalog-dir> | ||
|
|
||
| Replace ``<catalog-dir>`` in the example with the path to a directory on an | ||
| accessible filesystem. | ||
|
|
||
| Using a File-Based Warehouse | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| For this example, assume the Hive connector is being used, and the properties | ||
| in the Hive connector catalog file are set to the following: | ||
|
|
||
| .. code-block:: none | ||
|
|
||
| connector.name=hive | ||
| hive.metastore=file | ||
| hive.metastore.catalog.dir=file:///data/hive_data/ | ||
|
|
||
| Create a schema | ||
|
|
||
| .. code-block:: none | ||
|
|
||
| CREATE SCHEMA hive.warehouse; | ||
|
|
||
| This query creates a directory ``warehouse`` in the directory set for | ||
| ``hive.metastore.catalog.dir``, so the path to the new directory is | ||
| ``/data/hive_data/warehouse``. | ||
|
|
||
| Create a table with any connector-supported file formats. For example, if the | ||
| Hive connector is being configured: | ||
|
|
||
| .. code-block:: none | ||
|
|
||
| CREATE TABLE hive.warehouse.orders_csv("order_name" varchar, "quantity" varchar) WITH (format = 'CSV'); | ||
| CREATE TABLE hive.warehouse.orders_parquet("order_name" varchar, "quantity" int) WITH (format = 'PARQUET'); | ||
|
|
||
| These queries create folders as ``/data/hive_data/warehouse/orders_csv`` and | ||
| ``/data/hive_data/warehouse/orders_parquet``. Users can insert and query | ||
| from these tables. |
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.
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.
Uh oh!
There was an error while loading. Please reload this page.