@@ -21,7 +21,7 @@ A **DB_SPEC** (Database Specification) is a path-based identifier that precisely
2121
2222The general format follows this pattern:
2323
24- ```
24+ ``` text
2525<organization>/<database>/<repository>/<ref_type>/<ref_name>
2626```
2727
@@ -38,15 +38,15 @@ The general format follows this pattern:
3838Here are the most frequently used DB_SPEC formats, and special ones:
3939
4040#### Simple Database Reference (Default Branch)
41- ```
41+ ``` text
4242<organization>/<database>
4343```
4444** Example:** ` admin/my_database `
4545
4646This is shorthand for ` admin/my_database/local/branch/main ` - it automatically points to the main branch of the local repository.
4747
4848#### Specific Branch
49- ```
49+ ``` text
5050<organization>/<database>/local/branch/<branch_name>
5151```
5252** Examples:**
@@ -55,39 +55,39 @@ This is shorthand for `admin/my_database/local/branch/main` - it automatically p
5555- ` admin/customers/local/branch/feature-updates `
5656
5757#### Specific Commit
58- ```
58+ ``` text
5959<organization>/<database>/local/commit/<commit_id>
6060```
6161** Example:** ` admin/employees/local/commit/9w8hk3y6rb8tjdy961ed3i536ntkqd8 `
6262
6363Use this for time-travel queries or to reference a specific point in history.
6464
6565#### Repository Metadata
66- ```
66+ ``` text
6767<organization>/<database>/_meta
6868```
6969** Example:** ` admin/employees/_meta `
7070
7171Access the repository graph containing information about the local repository and all known remotes.
7272
7373#### Commit Graph
74- ```
74+ ``` text
7575<organization>/<database>/<repository>/_commits
7676```
7777** Example:** ` admin/employees/local/_commits `
7878
7979Access the commit graph containing branch histories, commit objects, authorship, and timestamps.
8080
8181#### Remote Repository
82- ```
82+ ``` text
8383<organization>/<database>/<remote_name>/branch/<branch_name>
8484```
8585** Example:** ` admin/employees/origin/branch/main `
8686
8787Reference a branch on a configured remote repository.
8888
8989#### System Database
90- ```
90+ ``` text
9191_system
9292```
9393Access the system metadata containing user information, organization data, and database records (requires system administrator permissions).
@@ -98,7 +98,7 @@ A **GRAPH_SPEC** (Graph Specification) extends a DB_SPEC to point to a specific
9898
9999### GRAPH_SPEC Structure
100100
101- ```
101+ ``` text
102102<DB_SPEC>/<graph_type>
103103```
104104
@@ -109,19 +109,19 @@ Where `<graph_type>` is one of:
109109### GRAPH_SPEC Examples
110110
111111#### Access Schema Graph
112- ```
112+ ``` text
113113admin/employees/local/branch/main/schema
114114```
115115Read or modify the schema (data model) for the employees database.
116116
117117#### Access Instance Graph
118- ```
118+ ``` text
119119admin/employees/local/branch/main/instance
120120```
121121Query or update the actual data documents in the employees database.
122122
123123#### Schema on Specific Commit
124- ```
124+ ``` text
125125admin/products/local/commit/abc123def456/schema
126126```
127127View the schema as it existed at a specific commit.
@@ -203,7 +203,7 @@ When components are omitted, TerminusDB applies these defaults:
203203
204204### Examples with Defaults
205205
206- ```
206+ ``` text
207207admin/mydb
208208↓ Expands to ↓
209209admin/mydb/local/branch/main
0 commit comments