danhuawang commented on code in PR #9173: URL: https://github.com/apache/gravitino/pull/9173#discussion_r2601708117
########## docs/lance-rest-service.md: ########## @@ -0,0 +1,391 @@ +--- +title: "Lance REST service" +slug: /lance-rest-service +keywords: + - Lance REST + - Lance datasets + - REST API +license: "This software is licensed under the Apache License version 2." +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +## Overview + +The Lance REST service provides a RESTful interface for managing Lance datasets through HTTP endpoints. Introduced in Gravitino version 1.1.0, this service enables seamless interaction with Lance datasets for data operations and metadata management. + +The service implements the [Lance REST API specification](https://docs.lancedb.com/api-reference/introduction). For detailed specification documentation, see the [official Lance REST documentation](https://lance.org/format/namespace/rest/catalog-spec/). + +### What is Lance? + +[Lance](https://lance.org/format/) is a modern columnar data format designed for AI/ML workloads. It provides: + +- **High-performance vector search**: Native support for similarity search on high-dimensional embeddings +- **Columnar storage**: Optimized for analytical queries and machine learning pipelines +- **Fast random access**: Efficient row-level operations unlike traditional columnar formats +- **Version control**: Built-in dataset versioning and time-travel capabilities +- **Incremental updates**: Append and update data without full rewrites + +### Architecture + +The Lance REST service acts as a bridge between Lance datasets and applications: + +``` +┌─────────────────┐ +│ Applications │ +│ (Python/Java) │ +└────────┬────────┘ + │ HTTP/REST + ▼ +┌─────────────────┐ +│ Lance REST │◄──── Gravitino Metalake +│ Service │ (Metadata Backend) +└────────┬────────┘ + │ File System Operations + ▼ +┌─────────────────┐ +│ Lance Datasets │ +│ (S3/GCS/Local) │ +└─────────────────┘ +``` + +**Key Features:** +- Full compliance with Lance REST API specification +- Can run standalone or integrated with Gravitino server +- Support for namespace and table management +- Index creation and management capabilities (Index operations are not supported in version 1.1.0) +- Metadata stored in Gravitino for unified governance + +## Supported Operations + +The Lance REST service provides comprehensive support for namespace management, table management, and index operations. The table below lists all supported operations: + +| Operation | Description | HTTP Method | Endpoint Pattern | Since Version | +|-------------------|-------------------------------------------------------------------|-------------|-------------------------------------|---------------| +| CreateNamespace | Create a new Lance namespace | POST | `/lance/v1/namespace/{id}/create` | 1.1.0 | +| ListNamespaces | List all namespaces under a parent namespace | GET | `/lance/v1/namespace/{parent}/list` | 1.1.0 | +| DescribeNamespace | Retrieve detailed information about a specific namespace | POST | `/lance/v1/namespace/{id}/describe` | 1.1.0 | +| DropNamespace | Delete a namespace | POST | `/lance/v1/namespace/{id}/drop` | 1.1.0 | +| NamespaceExists | Check whether a namespace exists | POST | `/lance/v1/namespace/{id}/exists` | 1.1.0 | +| ListTables | List all tables in a namespace | GET | `/lance/v1/table/{namespace}/list` | 1.1.0 | Review Comment: ListTable endpoint pattern will cause 404. Is it incorrect? I called by `/lance/v1/namespace/{id}/table/list` successfully. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
