Skip to content

Commit 7d186c3

Browse files
committed
docs: add doc for biglake support (lance-format#3)
1 parent 57b6777 commit 7d186c3

6 files changed

Lines changed: 829 additions & 14 deletions

File tree

.github/labeler.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Licensed under the Apache License, Version 2.0 (the "License");
2+
# you may not use this file except in compliance with the License.
3+
# You may obtain a copy of the License at
4+
#
5+
# http://www.apache.org/licenses/LICENSE-2.0
6+
#
7+
# Unless required by applicable law or agreed to in writing, software
8+
# distributed under the License is distributed on an "AS IS" BASIS,
9+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10+
# See the License for the specific language governing permissions and
11+
# limitations under the License.
12+
13+
version: 1
14+
appendOnly: true
15+
# Labels are applied based on conventional commits standard
16+
# https://www.conventionalcommits.org/en/v1.0.0/
17+
# These labels are later used in release notes. See .github/release.yml
18+
labels:
19+
# If the PR title has an ! before the : it will be considered a breaking change
20+
# For example, `feat!: add new feature` will be considered a breaking change
21+
- label: breaking-change
22+
title: "^[^:]+!:.*"
23+
- label: breaking-change
24+
body: "BREAKING CHANGE"
25+
- label: enhancement
26+
title: "^feat(\\(.+\\))?!?:.*"
27+
- label: bug
28+
title: "^fix(\\(.+\\))?!?:.*"
29+
- label: documentation
30+
title: "^docs(\\(.+\\))?!?:.*"
31+
- label: performance
32+
title: "^perf(\\(.+\\))?!?:.*"
33+
- label: ci
34+
title: "^ci(\\(.+\\))?!?:.*"
35+
- label: chore
36+
title: "^(chore|test|build|style)(\\(.+\\))?!?:.*"
37+
- label: java
38+
files:
39+
- "java\\/.*"
40+
- label: python
41+
files:
42+
- "python\\/.*"
43+
- label: docs
44+
files:
45+
- "docs\\/.*"

docs/mkdocs.yml

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,7 @@ theme:
2222
icon: material/brightness-4
2323
name: Switch to light mode
2424
features:
25-
- navigation.tabs
26-
- navigation.sections
2725
- navigation.instant
28-
- navigation.indexes
2926
- navigation.tracking
3027
- navigation.top
3128
- search.highlight
@@ -59,17 +56,7 @@ markdown_extensions:
5956

6057
plugins:
6158
- search
62-
63-
nav:
64-
- Hive MetaStore V2: hive2.md
65-
- Hive MetaStore V3: hive3.md
66-
- Iceberg REST Catalog: iceberg.md
67-
- Polaris: polaris.md
68-
- Unity Catalog: unity.md
69-
- AWS Glue: glue.md
70-
- Gravitino: gravitino.md
71-
- OneLake: onelake.md
72-
- Dataproc: dataproc.md
59+
- awesome-pages
7360

7461
extra:
7562
social:

docs/pyproject.toml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[project]
2+
name = "lance-namespace-impls-docs"
3+
version = "0.1.0"
4+
description = "Documentation for Lance Namespace Implementations"
5+
requires-python = ">=3.9"
6+
dependencies = [
7+
"mkdocs>=1.5.0",
8+
"mkdocs-material>=9.4.0",
9+
"mkdocs-awesome-pages-plugin>=2.10.1",
10+
]

docs/src/.pages

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
nav:
2+
- Apache Gravitino: gravitino.md
3+
- Apache Hive MetaStore V2: hive2.md
4+
- Apache Hive MetaStore V3: hive3.md
5+
- Apache Iceberg REST Catalog: iceberg.md
6+
- Apache Polaris: polaris.md
7+
- AWS Glue: glue.md
8+
- Google BigLake: biglake.md
9+
- Google Dataproc: dataproc.md
10+
- Microsoft OneLake: onelake.md
11+
- Unity Catalog: unity.md

docs/src/biglake.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Lance BigLake Namespace
2+
3+
**Google BigLake Metastore** is a fully managed, unified metastore service for data lakes on Google Cloud.
4+
5+
To use Google BigLake Metastore with Lance, you can leverage BigLake's [Iceberg REST Catalog](https://docs.cloud.google.com/biglake/docs/blms-rest-catalog),
6+
which exposes an Apache Iceberg REST Catalog-compatible interface.
7+
8+
## Configuration
9+
10+
Configure your Lance Iceberg namespace to connect to the BigLake Metastore endpoint:
11+
12+
- **endpoint**: `https://biglake.googleapis.com/iceberg/v1/restcatalog`
13+
- **warehouse**: Your BigLake catalog name in the format `projects/{project}/locations/{location}/catalogs/{catalog}`
14+
- **auth_token**: A valid Google Cloud OAuth2 access token
15+
16+
All the features and configurations of the [Lance Iceberg REST Catalog Namespace](iceberg.md) apply when using BigLake Metastore.

0 commit comments

Comments
 (0)