Merge pull request #2409 from dolthub/taylor/dg-sys-tables

Restructure doltgres system table docs

Author: tbantle22

Diff for: packages/dolt/content/reference/sql/version-control/dolt-system-tables.md

@@ -153,6 +153,12 @@ guaranteed to see these changes reflected in the files on disk.
 +----------+------+
 ```
 
+### Example
+
+Gets all docs.
+
+{% embed url="https://www.dolthub.com/repositories/dolthub/first-hour-db/embed/main?q=select+*+from+dolt_docs%3B" %}
+
 ## `dolt_procedures`
 
 `dolt_procedures` stores each stored procedure that has been created
@@ -386,25 +392,22 @@ commit graph and is not subject to versioning semantics.
 +-----------------+----------+------+-----+---------+-------+
 | Field           | Type     | Null | Key | Default | Extra |
 +-----------------+----------+------+-----+---------+-------+
-| database        | text     | NO   | PRI | NULL    |       |
-| table           | text     | NO   | PRI | NULL    |       |
-| index           | text     | NO   | PRI | NULL    |       |
-| position        | bigint   | NO   | PRI | NULL    |       |
-| version         | bigint   | NO   |     | NULL    |       |
-| commit_hash     | text     | NO   |     | NULL    |       |
+| database_name   | text     | NO   | PRI | NULL    |       |
+| table_name      | text     | NO   | PRI | NULL    |       |
+| index_name      | text     | NO   | PRI | NULL    |       |
 | row_count       | bigint   | NO   |     | NULL    |       |
 | distinct_count  | bigint   | NO   |     | NULL    |       |
 | null_count      | bigint   | NO   |     | NULL    |       |
-| columns         | json     | NO   |     | NULL    |       |
-| types           | json     | NO   |     | NULL    |       |
-| upper_bound     | json     | NO   |     | NULL    |       |
+| columns         | text     | NO   |     | NULL    |       |
+| types           | text     | NO   |     | NULL    |       |
+| upper_bound     | text     | NO   |     | NULL    |       |
 | upper_bound_cnt | bigint   | NO   |     | NULL    |       |
 | created_at      | datetime | NO   |     | NULL    |       |
-| mcv1            | json     | NO   |     | NULL    |       |
-| mcv2            | json     | NO   |     | NULL    |       |
-| mcv3            | json     | NO   |     | NULL    |       |
-| mcv4            | json     | NO   |     | NULL    |       |
-| mcvCounts       | json     | NO   |     | NULL    |       |
+| mcv1            | text     | NO   |     | NULL    |       |
+| mcv2            | text     | NO   |     | NULL    |       |
+| mcv3            | text     | NO   |     | NULL    |       |
+| mcv4            | text     | NO   |     | NULL    |       |
+| mcvCounts       | text     | NO   |     | NULL    |       |
 +-----------------+----------+------+-----+---------+-------+
 ```
 
@@ -906,7 +909,7 @@ num_inmates_rated_for have changed the most between 2 versions.
 
 ## `dolt_conflicts`
 
-dolt_conflicts is a system table that has a row for every table in the working set that has an unresolved merge
+`dolt_conflicts` is a system table that has a row for every table in the working set that has an unresolved merge
 conflict.
 
 ```sql
@@ -985,18 +988,18 @@ And of course you can use any combination of `ours`, `theirs` and
   primary key (or keyless hash). If the row does not exist, it will be inserted.
   Updates made to `our_` columns will never delete a row, however.
 
-- `dolt_conflict_id` is a unique identifier for the conflict. It is particulary
+- `dolt_conflict_id` is a unique identifier for the conflict. It is particularly
   useful when writing software that needs to resolve conflicts automatically.
 
 - `from_root_ish` is the commit hash of the "from branch" of the merge. This
   hash can be used to identify which merge produced a conflict, since conflicts
-  can accumalate across merges.
+  can accumulate across merges.
 
 {% endhint %}
 
 ## `dolt_schema_conflicts`
 
-dolt_schema_conflicts is a system table that has a row for every table in the working
+`dolt_schema_conflicts` is a system table that has a row for every table in the working
 set that has an unresolved schema conflict.
 
 ```sql
@@ -1020,19 +1023,19 @@ resolving schema conflicts during merge, see the docs on [conflicts](./merges.md
 
 ## `dolt_merge_status`
 
-The dolt_merge_status system table tells a user if a merge is active. It has the following schema:
+The `dolt_merge_status` system table tells a user if a merge is active. It has the following schema:
 
 ```sql
 CREATE TABLE `dolt_merge_status` (
--- Whether a merge is currently active or not
+  -- Whether a merge is currently active or not
   `is_merging` tinyint NOT NULL,
- -- The commit spec that was used to initiate the merge
+  -- The commit spec that was used to initiate the merge
   `source` text,
--- The commit that the commit spec resolved to at the time of merge
+  -- The commit that the commit spec resolved to at the time of merge
   `source_commit` text,
--- The target destination working set
+  -- The target destination working set
   `target` text,
--- A list of tables that have conflicts or constraint violations
+  -- A list of tables that have conflicts or constraint violations
   `unmerged_tables` text
 )
 ```
@@ -1115,13 +1118,13 @@ These tables can be modified in order to update what changes are staged for comm
 
 ### Schema
 
-The schema of the source table is going to effect the schema of the workspace table. The first
+The schema of the source table is going to affect the schema of the workspace table. The first
 three column are always the same, then the schema of the source table is used to create "to\_" and
 "from\_" columns.
 
 Each row in the `dolt_workspace_$TABLENAME` corresponds to a single row update in the table.
 
-```text
+```sql
 +------------------+----------+
 | field            | type     |
 +------------------+----------+
@@ -1156,7 +1159,7 @@ FROM dolt_workspace_mytable
 WHERE staged=false
 ```
 
-```text
+```sql
 +----+--------+-----------+-------+----------+---------+------------+
 | id | staged | diff_type | to_id | to_value | from_id | from_value |
 +----+--------+-----------+-------+----------+---------+------------+

Diff for: packages/doltgres/content/reference/sql/version-control/dolt-sql-procedures.md

@@ -1066,27 +1066,26 @@ select dolt_commit('-am', 'inserting row 3');
 
 -- check out what our commit history on branch1 looks like before we rebase
 select commit_hash, message from dolt_log;
-+----------------------------------+----------------------------+
-| commit_hash                      | message                    |
-+----------------------------------+----------------------------+
-| tsq01op7b48ij6dfa2tst60vbfm9rcus | inserting row 3            |
-| uou7dibe86e9939pu8fdtjdce5pt7v1c | inserting row 2            |
-| 3umkjmqeeep5ho7nn0iggfinajoo1l6q | inserting row 1            |
-| 35gfll6o322aq9uffdqin1dqmq7q3vek | creating table t           |
-| do1tp9u39vsja3c8umshv9p6fernr0lt | Inіtіalizе dаta repоsitоry |
-+----------------------------------+----------------------------+
+           commit_hash            |          message
+----------------------------------+----------------------------
+ m2v3oajs9jesvvc44ihqlsu1uq2c8jf2 | inserting row 3
+ qa1t5ieqs418s1b7mssqlmpn68ackq20 | inserting row 2
+ tgltn67jjho1mp8a3jdl3jkip08jbbun | inserting row 1
+ nof0lk6ufv031mddiahqfqfelqcpjdv5 | creating table t
+ pfjaqljdrdn43877sbc2d2sla9g3eb8u | CREATE DATABASE
+ k23mej9jdej41s0n7o2g8gp5rpgvrfdb | Initialize data repository
+(6 rows)
 
 -- start an interactive rebase and check out the default rebase plan; this will rebase
 -- all the new commits on this branch and move them to the tip of the main branch
 select dolt_rebase('-i', 'main');
 select * from dolt_rebase order by rebase_order;
-+--------------+--------+----------------------------------+-----------------+
-| rebase_order | action | commit_hash                      | commit_message  |
-+--------------+--------+----------------------------------+-----------------+
-| 1.00         | pick   | 3umkjmqeeep5ho7nn0iggfinajoo1l6q | inserting row 1 |
-| 2.00         | pick   | uou7dibe86e9939pu8fdtjdce5pt7v1c | inserting row 2 |
-| 3.00         | pick   | tsq01op7b48ij6dfa2tst60vbfm9rcus | inserting row 3 |
-+--------------+--------+----------------------------------+-----------------+
+ rebase_order | action |           commit_hash            | commit_message
+--------------+--------+----------------------------------+-----------------
+         1.00 | pick   | tgltn67jjho1mp8a3jdl3jkip08jbbun | inserting row 1
+         2.00 | pick   | qa1t5ieqs418s1b7mssqlmpn68ackq20 | inserting row 2
+         3.00 | pick   | m2v3oajs9jesvvc44ihqlsu1uq2c8jf2 | inserting row 3
+(3 rows)
 
 -- adjust the rebase plan to reword the first commit, drop the commit that inserted row 2,
 -- and combine the third commit into the previous commit
@@ -1099,14 +1098,14 @@ select dolt_rebase('--continue');
 
 -- check out the history
 select commit_hash, message from dolt_log;
-+----------------------------------+----------------------------+
-| commit_hash                      | message                    |
-+----------------------------------+----------------------------+
-| 8jc1dpj25fv6f2kn3bd47uokc8hs1vp0 | insert rows                |
-| hb9fnqnrsd5ghq3fgag0kiq6nvpsasvo | inserting row 0            |
-| 35gfll6o322aq9uffdqin1dqmq7q3vek | creating table t           |
-| do1tp9u39vsja3c8umshv9p6fernr0lt | Inіtіalizе dаta repоsitоry |
-+----------------------------------+----------------------------+
+           commit_hash            |          message
+----------------------------------+----------------------------
+ 8jc1dpj25fv6f2kn3bd47uokc8hs1vp0 | insert rows
+ gd5rnrmjvbf0fb6sb8dfaf5a344t68ei | inserting row 0
+ nof0lk6ufv031mddiahqfqfelqcpjdv5 | creating table t
+ pfjaqljdrdn43877sbc2d2sla9g3eb8u | CREATE DATABASE
+ k23mej9jdej41s0n7o2g8gp5rpgvrfdb | Initialize data repository
+(5 rows)
 ```
 
 ## `DOLT_REMOTE()`