Update DB docs with new SQL specification options

This commit is contained in:
Jeff Mitchell 2016-08-03 15:45:56 -04:00
parent 45ab722845
commit 1b0c9afc43
4 changed files with 26 additions and 17 deletions

View File

@ -217,20 +217,23 @@ subpath for interactive help output.
<li>
<span class="param">creation_cql</span>
<span class="param-flags">optional</span>
The CQL statements executed to create and configure the new user.
Must be semi-colon separated. The '{{username}}' and '{{password}}'
values will be substituted; it is required that these parameters are
in single quotes. The default creates a non-superuser user with
no authorization grants.
The CQL statements executed to create and configure the new user. Must
be a semicolon-separated string, a base64-encoded semicolon-separated
string, a serialized JSON string array, or a base64-encoded serialized
JSON string array. The '{{username}}' and '{{password}}' values will be
substituted; it is required that these parameters are in single quotes.
The default creates a non-superuser user with no authorization grants.
</li>
<li>
<span class="param">rollback_cql</span>
<span class="param-flags">optional</span>
The CQL statements executed to attempt a rollback if an error is
encountered during user creation. The default is to delete the user.
Must be semi-colon separated. The '{{username}}' and '{{password}}'
values will be substituted; it is required that these parameters are
in single quotes.
Must be a semicolon-separated string, a base64-encoded
semicolon-separated string, a serialized JSON string array, or a
base64-encoded serialized JSON string array. The '{{username}}' and
'{{password}}' values will be substituted; it is required that these
parameters are in single quotes.
</li>
<li>
<span class="param">lease</span>

View File

@ -222,9 +222,11 @@ allowed to read.
<li>
<span class="param">sql</span>
<span class="param-flags">required</span>
The SQL statements executed to create and configure the role.
Must be semi-colon separated. The '{{name}}' and '{{password}}'
values will be substituted.
The SQL statements executed to create and configure the role. The
'{{name}}' and '{{password}}' values will be substituted. Must be a
semicolon-separated string, a base64-encoded semicolon-separated
string, a serialized JSON string array, or a base64-encoded serialized
JSON string array.
</li>
</ul>
</dd>

View File

@ -249,9 +249,11 @@ the default on versions prior to that.
<li>
<span class="param">sql</span>
<span class="param-flags">required</span>
The SQL statements executed to create and configure the role.
Must be semi-colon separated. The '{{name}}' and '{{password}}'
values will be substituted.
The SQL statements executed to create and configure the role. Must be
a semicolon-separated string, a base64-encoded semicolon-separated
string, a serialized JSON string array, or a base64-encoded serialized
JSON string array. The '{{name}}' and '{{password}}' values will be
substituted.
</li>
<li>
<span class="param">rolename_length</span>

View File

@ -241,9 +241,11 @@ subpath for interactive help output.
<li>
<span class="param">sql</span>
<span class="param-flags">required</span>
The SQL statements executed to create and configure the role.
Must be semi-colon separated. The '{{name}}', '{{password}}' and
'{{expiration}}' values will be substituted.
The SQL statements executed to create and configure the role. Must be
a semicolon-separated string, a base64-encoded semicolon-separated
string, a serialized JSON string array, or a base64-encoded serialized
JSON string array. The '{{name}}', '{{password}}' and '{{expiration}}'
values will be substituted.
</li>
</ul>
</dd>