https://github.com/altinity/antalya-examples
Documentation and sample code for Altinity's Antalya branch of ClickHouse®
https://github.com/altinity/antalya-examples
Last synced: 8 months ago
JSON representation
Documentation and sample code for Altinity's Antalya branch of ClickHouse®
- Host: GitHub
- URL: https://github.com/altinity/antalya-examples
- Owner: Altinity
- License: apache-2.0
- Created: 2025-02-11T02:30:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-21T14:52:25.000Z (9 months ago)
- Last Synced: 2025-05-21T15:51:39.761Z (9 months ago)
- Language: Python
- Homepage:
- Size: 235 KB
- Stars: 43
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Altinity Project Antalya Examples
Project Antalya is a new branch of ClickHouse® code designed to
integrate real-time analytic query with data lakes. This project
provides documentation as well as working code examples to help you use
and contribute to Antalya.
*Important Note!* Altinity maintains and supports Project Antalya. Altinity
is not affiliated or associated with ClickHouse Inc any way. ClickHouse® is
a registered trademark of ClickHouse, Inc.
See the
[Community Support Section](#community-support) if you want to ask
questions or log ideas and issues.
## Project Antalya Goals and Roadmap
The main goals of Antalya are as follows.
* Enable real-time analytics to work off a single copy of
data that is shared with AI and data science applications.
* Provide a single SQL endpoint for native ClickHouse® and data lake data.
* Use open table formats to enable easy access from any application type.
* Separate compute and storage; moreover, allow users to scale compute
for ingest, merge, transformatino, and query independently.
Antalya will implement these goals through the following concrete features:
1. Optimize query performance of ClickHouse® on Parquet files stored
S3-compatible object storage.
2. Enable ClickHouse® clusters to add pools of stateless servers aka swarm
clusters that handle query and insert operations on shared object storage
files with linear scaling.
3. Adapt ClickHouse® to use Iceberg tables as shared storage.
4. Enable ClickHouse® clusters to extend existing tables onto unlimited
Iceberg storage with transparent query across both native MergeTree and
Parquet data.
5. Simplify backup and DR by leveraging Iceberg snapshots.
6. Maintain full compability with upstream ClickHouse® features and
bug fixes.
At this time Project Antalya builds demonstrate features 1, 2, 3 (partially), and 6.
## Licensing
Project Antalya code is licensed under Apache 2.0 license. There are no feature
hold-backs.
## Quick Start
See the [Docker Quick Start](./docker/README.md) to try out Antalya in
a few minutes using Docker Compose on a laptop.
## Scalable Swarm Example
For a fully functional swarm cluster implemention, look at the
[kubernetes](kubernetes/README.md) example. It demonstrates use of swarm
clusters on a large blockchain dataset stored in Parquet.
## Project Antalya Binaries
### Packages
Project Antalya ClickHouse® server and keeper packages are available on the
[builds.altinity.cloud](https://builds.altinity.cloud/) page. Scan to the last
section to find them.
### Containers
Project Antalya ClickHouse® server and ClickHouse® keeper containers are available
on Docker Hub. To start Antalya run the following Docker commands:
```
docker run altinity/clickhouse-server:25.2.2.27660.altinityantalya
docker run altinity/clickhouse-keeper:25.2.2.27660.altinityantalya
```
Check for the latest build on
[Docker Hub](https://hub.docker.com/r/altinity/clickhouse-server/tags).
## Documentation
Look in the docs directory for current documentation.
* [Project Antalya Concepts Guide](docs/concepts.md)
* [Project Antalya Feature Status](docs/feature-status.md)
* [Command and Configuration Reference](docs/reference.md)
See also the [Project Antalya Launch Video](https://altinity.com/events/scale-clickhouse-queries-infinitely-with-10x-cheaper-storage-introducing-project-antalya)
for an introduction to Project Antalya and a demo of performance.
## Code
To access Project Antalya code run the following commands.
```
git clone git@github.com:Altinity/ClickHouse.git Altinity-ClickHouse
cd Altinity-ClickHouse
git branch
```
You will be in the antalya branch by default.
## Building
Build instructions are located [here](https://github.com/Altinity/ClickHouse/blob/antalya/docs/en/development/developer-instruction.md)
in the Altinity ClickHouse code tree. Project Antalya code does not
introduce new libaries or build procedures.
## Contributing
We welcome contributions. We're setting up procedures for community
contribution. For now, please contact us in Slack to find out how to
join the project.
## Community Support
Join the [AltinityDB Slack Workspace](https://altinity.com/slack) or
[log an issue](https://github.com/Altinity/antalya-examples/issues) to get help.
## Commercial Support
Altinity is the primary maintainer of Project Antalya. It is the basis of our data
lake-enabled Altinity.Cloud and is also used in self-managed installations.
Altinity offers a range of services related to ClickHouse® and data lakes.
- [Official website](https://altinity.com/) - Get a high level overview of Altinity and our offerings.
- [Altinity.Cloud](https://altinity.com/cloud-database/) - Run ClickHouse® in our cloud or yours.
- [Altinity Support](https://altinity.com/support/) - Get Enterprise-class support for ClickHouse®.
- [Slack](https://altinity.com/slack) - Talk directly with ClickHouse® users and Altinity devs.
- [Contact us](https://hubs.la/Q020sH3Z0) - Contact Altinity with your questions or issues.
- [Free consultation](https://hubs.la/Q020sHkv0) - Get a free consultation with a ClickHouse® expert today.