Repository files navigation

Apache Gravitino is a high-performance, geo-distributed, and federated metadata lake. It manages metadata directly in different sources, types, and regions, providing users with unified metadata access for data and AI assets.

Gravitino aims to provide several key features:

• Unified Metadata Management: Gravitino provides a unified model and API to manage different types of metadata, including relational (e.g., Hive, MySQL) and file-based (e.g., HDFS, S3) metadata sources.
• End-to-End Data Governance: Gravitino offers a unified governance layer for managing metadata with features like access control, auditing, and discovery.
• Direct Metadata Management: Gravitino connects directly to metadata sources via connectors, ensuring changes are instantly reflected between Gravitino and the underlying systems.
• Geo-Distribution Support: Gravitino enables deployment across multiple regions or clouds, allowing instances to share metadata for a global cross-region view.
• Multi-Engine Support: Gravitino supports query engines enabling metadata access without modifying SQL dialects.
• AI Asset Management (WIP): Gravitino is expanding to manage both data and AI assets, with support for AI models and features currently in development.

Gravitino is open source software available under the Apache 2.0 license. For information on contributing to Gravitino, please see theContribution guidelines.

The latest Gravitino documentation is available on ourofficial website. This README file only contains basic setup instructions.

You can build Gravitino using Gradle. Currently, you can build Gravitino on Linux and macOS, and Windows isn't supported.

To build Gravitino, please run:

./gradlew clean build -xtest

If you want to build a distribution package, please run:

./gradlew compileDistribution -xtest

to build a distribution package.

Or:

./gradlew assembleDistribution -xtest

to build a compressed distribution package.

The directorydistribution contains the generated binary distribution package.

Please seeHow to build Gravitino for details on building and testing Gravitino.

This is the recommended approach. Gravitino provides a docker-compose-based playground where you can experience a whole system alongside other components. Clone or download theGravitino playground repository and then follow theREADME, to get everything running.

To start Gravitino on your machine, download a binary package from thedownload page and decompress the package.

Before starting the Gravitino server, configure its settings by editing thegravitino.conf file located in theconf directory. This file follows the standard properties file format, allowing you to modify the server configuration as needed.

To start the Gravitino server, please run:

./bin/gravitino.sh start

To stop the Gravitino server, please run:

./bin/gravitino.sh stop

Alternatively, to run the Gravitino server in the frontend, please run:

./bin/gravitino.sh run

And pressCTRL+C to stop the Gravitino server.

Gravitino provides Iceberg REST catalog service to manage Iceberg efficiently. For more details, refer toGravitino Iceberg REST catalog service.

Gravitino provides a Trino connector for accessing metadata within Gravitino. To use Trino with Gravitino, please follow thetrino-gravitino-connector doc.

1. How to build Gravitino
2. How to test Gravitino
3. How to publish Docker images

Gravitino is licensed under the Apache License Version 2.0. For details, see theLICENSE.

Apache Gravitino is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required for all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

_{Apache®, Apache Gravitino™, Apache Hadoop®, Apache Hive™, Apache Iceberg™, Apache Kafka®, Apache Spark™, Apache Submarine™, Apache Thrift™ and Apache Zeppelin™ are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries.}