Skip to content

Commit 6aca10b

Browse files
author
James Cor
committed
bring back comments for engine
1 parent 1fd170a commit 6aca10b

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

engine.go

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,17 @@ func init() {
5151

5252
// Config for the Engine.
5353
type Config struct {
54-
VersionPostfix string
55-
TemporaryUsers []TemporaryUser
56-
IsReadOnly bool
57-
IsServerLocked bool
54+
// VersionPostfix to display with the `VERSION()` UDF.
55+
VersionPostfix string
56+
// TemporaryUsers adds any users that should be included when the engine is created. By default, authentication is
57+
// disabled, and including any users here will enable authentication. All users in this list will have full access.
58+
// This field is only temporary, and will be removed as development on users and authentication continues.
59+
TemporaryUsers []TemporaryUser
60+
// IsReadOnly sets the engine to disallow modification queries.
61+
IsReadOnly bool
62+
IsServerLocked bool
63+
// IncludeRootAccount adds the root account (with no password) to the list of accounts, and also enables
64+
// authentication.
5865
IncludeRootAccount bool
5966
}
6067

0 commit comments

Comments
 (0)