stardog-admin db offline Manual Page

NAME


stardog-admin db offline —Takes a database offline.

SYNOPSIS


stardog-admin [ --krb5 ] [ --krb5-disable-rdns ] [ --server <server url> ]db offline [ {-p | --passwd} <password> ] [ {-P | --ask-password} ] [ --timeout <timeout> ] [ {-u | --username} <username> ] [ {-v | --verbose} ] [--] <database>

OPTIONS


--krb5
Use the Kerberos environment.
--krb5-disable-rdns
Disable reverse DNS lookup for Kerberos clients.
-p <password>, --passwd <password>
Password.
-P, --ask-password
Prompt for password.
--server <server url>
URL of Stardog Server. If this option isn't specified, it will be read from JVM argument 'stardog.default.cli.server'. If the JVM arg isn't set, the default value 'http://localhost:5820' is used. If server URL has no explicit port value, the default port value '5820' is used. Example: 'stardog-admin --server http://12.34.56.78:5820 server stop'
--timeout <timeout>
Timeout in ms to wait before database is put offline. An optional time unit can be specified by the suffix 'h' (for hours), 'm' (for minutes), or 's' (for seconds). If no timeout is specified, the default timeout of 5 seconds is used.
-u <username>, --username <username>
User name.
-v, --verbose
Verbose flag that causes more detailed information to be printed
--
This option can be used to separate command-line options from the list of argument, (useful when arguments might be mistaken for command-line options
<database>
The name of the database for the operation

DISCUSSION


Initiates the offlining of a database. The offline operation optionally takes a timeout which, when specified, provides a window where the database is not yet offline. While in this window, no new connections will be accepted but all open connections will be allowed to complete their actions. Once the timeout has been reached, any remaining connections are closed, open transactions are rolled back, and the database is put offline.

EXAMPLES


Take a database 'foo' offline:

    $ stardog-admin db offline foo

Take the database 'foo' offline, but wait 15 minutes for open connections to complete their actions:

    $ stardog-admin db offline --timeout 15m foo 

Take the database 'foo' offline immediately:

    $ stardog-admin db offline --timeout 0 foo