Skip to content

Commit 02de037

Browse files
authored
feat: introduce concept of recommended basic operations (#235)
This provides additional guidelines for people that would like to provide new implementations, or implement the REST standard. cc @jerryshao @yuqi1129
1 parent 41d0115 commit 02de037

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

docs/src/operations/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,24 @@ The Lance Namespace Specification defines a list of operations that can be perfo
4242
| [DescribeTransaction](describe-transaction.md) | 1 | | | || ||
4343
| [AlterTransaction](alter-transaction.md) | 1 | | | || ||
4444

45+
## Recommended Basic Operations
46+
47+
To have a functional basic namespace implementation, the following metadata operations are recommended as a minimum:
48+
49+
**Namespace Metadata Operations:**
50+
- [CreateNamespace](create-namespace.md) - Create a new namespace
51+
- [ListNamespaces](list-namespaces.md) - List available namespaces
52+
- [DescribeNamespace](describe-namespace.md) - Get namespace details
53+
- [DropNamespace](drop-namespace.md) - Remove a namespace
54+
55+
**Table Metadata Operations:**
56+
- [CreateEmptyTable](create-empty-table.md) - Create an empty table (metadata only)
57+
- [ListTables](list-tables.md) - List tables in a namespace
58+
- [DescribeTable](describe-table.md) - Get table details
59+
- [DropTable](drop-table.md) - Remove a table
60+
61+
These operations provide the foundational metadata management capabilities needed for namespace and table administration without requiring data or index operation support. With the namespace able to provide basic information about the table, the Lance SDK can be used to fulfill the other operations.
62+
4563
## Operation Versioning
4664

4765
When backwards incompatible change is introduced,

0 commit comments

Comments
 (0)