taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

taler-auditor-dbconfig.1.rst (2051B)


      1 taler-auditor-dbconfig(1)
      2 #########################
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **taler-auditor-dbconfig** - configure Taler auditor database
     10 
     11 
     12 Synopsis
     13 ========
     14 
     15 **taler-auditor-dbconfig**
     16 [**--dry**]
     17 [**-c** *FILENAME*]
     18 [**-h**]
     19 [**-n** *NAME*]
     20 [**-r**]
     21 [**-s**]
     22 [**-u** *USER*]
     23 
     24 Description
     25 ===========
     26 
     27 **taler-auditor-dbconfig** is a simple shell script that configures
     28 a Postgresql database for use by the GNU Taler auditor.
     29 
     30 Its options are as follows:
     31 
     32 **--dry**
     33    Report pending role/database creation, permission setup, and schema or
     34    stored-procedure migrations without changing PostgreSQL state. Existing
     35    databases are inspected by invoking the corresponding dbinit tool with
     36    ``--dry`` as the configured service user. Root and the service operating
     37    system account are still required, as for normal dbconfig operation.
     38 
     39    If the database or PostgreSQL role does not exist, report its creation
     40    followed by full initialization. Individual migrations are not enumerated
     41    until the target can be inspected. With ``-s``, omit initialization;
     42    combining ``--dry`` with ``-r`` is an error.
     43 
     44    Output is empty when current. Exit status is 0 when current, 2 when work
     45    is pending, and 1 on error. Database inspection failures are errors, not
     46    evidence that a database or role is missing.
     47 
     48 **-c** *FILENAME*
     49    Write the database configuration to FILENAME. The tool
     50    will append the required ``CONFIG`` option for the
     51    Postgresql access to the respective file.
     52 
     53 **-h**
     54    Print short help on options.
     55 
     56 **-n** *DBNAME*
     57    Use DBNAME for the name of the created database.
     58 
     59 **-r**
     60    Reset any existing database. Looses all existing data. DANGEROUS.
     61 
     62 **-s**
     63    Skip database initialization. Useful if you want to run
     64    ``taler-auditor-dbinit`` manually.
     65 
     66 **-u** *USER*
     67    Specifies the (main) auditor user that will access the database.
     68 
     69 See Also
     70 ========
     71 
     72 taler-auditor-dbinit(1), taler-auditor.conf(5).
     73 
     74 Bugs
     75 ====
     76 
     77 Report bugs by using https://bugs.taler.net or by sending electronic
     78 mail to <taler@gnu.org>.