Skip to content

Commit 00cc89b

Browse files
authored
Merge pull request #2602 from dolthub/fulghum/minor-doc-updates
Update docs for `dolt_commit()` stored procedure
2 parents 9d8a878 + 7ce293f commit 00cc89b

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

packages/dolt/content/reference/sql/version-control/dolt-sql-procedures.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -644,8 +644,11 @@ SELECT * FROM DOLT_REMOTES;
644644

645645
## `DOLT_COMMIT()`
646646

647-
Commits staged tables to HEAD. Works exactly like `dolt commit` with
648-
each value directly following the flag.
647+
Commits staged tables to HEAD. Works like `dolt commit` with
648+
each value directly following the flag. The one difference is that the
649+
default commit author is the authenticated SQL user (e.g. `root@localhost`)
650+
instead of the `user.name` and `user.email` properties configured via
651+
`dolt config`.
649652

650653
`DOLT_COMMIT()` also commits the current transaction.
651654

@@ -669,11 +672,9 @@ default. This option bypasses that safety.
669672

670673
`--skip-empty`: Record a commit only if there are changes to be committed. The commit operation will be a no-op, instead of an error, if there are no changes staged to commit. An error will be thrown if `--skip-empty` is used with `--allow-empty`.
671674

672-
`--date`: Specify the date used in the commit. If not specified the
673-
current system time is used.
675+
`--date`: Specify the date used in the commit. If not specified, the current system time is used.
674676

675-
`--author`: Specify an explicit author using the standard "A U Thor
676-
677+
`--author`: Specify an explicit author using the standard "A U Thor [email protected]" format. Note that unlike `dolt commit` on the CLI, when invoking the `dolt_commit()` stored procedure, the default commit author is the authenticated SQL user (e.g. `root@localhost`).
677678

678679
### Output Schema
679680

0 commit comments

Comments
 (0)