Skip to content

Commit

Permalink
Document valid branch names (#1799)
Browse files Browse the repository at this point in the history
  • Loading branch information
macneale4 authored Oct 24, 2023
1 parent d3d88cd commit cd20ba0
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion content/reference/sql/version-control/dolt-sql-procedures.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,22 @@ CALL DOLT_BRANCH('-m', 'currentBranchName', 'newBranchName')

### Notes

- The `dolt_branch()` procedure implicitly commits the current transaction and begins a new one.
Branch names have a few restrictions which are similar to the constraints Git puts on branch names. Dolt's branches are a little more restrictive, as [ASCII](https://en.wikipedia.org/wiki/ASCII) characters are required. Rules are as follows:

- All characters must be ASCII (7 Bit)
- May not start with '.' (period)
- May not contain '..' (two periods)
- May not contain '@{'
- May not contain ASCII control characters
- May not contain characters: ':', '?', '\[', '\', '^', '~', '*'
- May not contain whitespace (spaces, tabs, newlines)
- May not end with '/'
- May not end with '.lock'
- May not be HEAD (case insensitive)
- May not be indistinguishable from a commit hash. 32 characters, where all characters are 0-9 or a-z (case sensitive)


The `dolt_branch()` procedure implicitly commits the current transaction and begins a new one.

{% endhint %}

Expand Down

0 comments on commit cd20ba0

Please sign in to comment.