You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/format/table/branch_tag.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,9 @@ Branch names must follow these validation rules:
17
17
4. Cannot contain `..` or `\`
18
18
5. Segments must contain only alphanumeric characters, `.`, `-`, `_`
19
19
6. Cannot end with `.lock`
20
-
7. Cannot be named `main` (reserved for main branch)
20
+
7. Cannot be named `main` (reserved for the default branch)
21
+
22
+
`main` is a virtual name for the default branch. It may appear in API reference contexts as an alias for the default branch, but no branch metadata file named `main.json` is created.
21
23
22
24
### Branch Metadata Path
23
25
@@ -38,7 +40,7 @@ Each branch metadata file is a JSON file with the following fields:
Copy file name to clipboardExpand all lines: docs/src/guide/tags_and_branches.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,8 @@ The `reference` parameter (used in `create`, `update`, and `checkout_version`) a
20
20
-`("experiment", 3)` means version 3 on the experiment branch
21
21
-`("branch-name", None)` means the latest version on that branch
22
22
23
+
In reference contexts, `"main"` is an alias for the default branch and is equivalent to `None`.
24
+
23
25
!!! note
24
26
25
27
Creating or deleting tags does not generate new dataset versions.
@@ -77,7 +79,7 @@ The `reference` parameter works the same as for Tags (see above).
77
79
78
80
Each branch maintains its own linear version history, so version numbers may overlap across branches. Use `(branch_name, version_number)` tuples as global identifiers for operations like `checkout_version` and `tags.create`.
79
81
80
-
"main" is a reserved branch name. Lance uses "main" to identify the default branch.
82
+
`"main"` is reserved for the default branch. Use `"main"` or `None` when referring to the default branch in reference tuples or checkout APIs, but choose a different name when creating, deleting, or updating branches.
Copy file name to clipboardExpand all lines: docs/src/quickstart/versioning.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,6 +95,8 @@ For advanced tag operations (e.g., tagging versions on specific branches), see [
95
95
96
96
Branches manage parallel lines of dataset evolution. You can create branches from existing versions or tags, read and write to them independently, and checkout different branches.
97
97
98
+
`main` refers to the default branch in checkout and reference APIs, but it is reserved and cannot be used as the name of a new branch.
0 commit comments