Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

-schema

Name of CAST schema to backup.

-password

CAST Storage Service/PostgreSQL instance "operator" password.

-file

Path and name of backup dump file, using the .cssdmp extension. Backup will fail if this file already exists.

-log

Path and name of output log file - does not need to exist already (logging functions in append mode). The resulting file is text based. Note that you can increase logging verbosity by using the parameter set CASTLOGMODE=DEBUG at the start of your command line, e.g.:

Code Block
languagetext
set CASTLOGMODE=DEBUG
CSSBackup.exe
-schema <schema_name>
-password <Operator_password>
-file <path_and_name_of_backup_file.cssdmp>
-log <path_and_name_of_log_file.log>

Additional optional parameters

...

-host

...

Name/IP address of machine hosting the CAST Storage Service/PostgreSQL instance (default: localhost). Only required if the CAST Storage Service/PostgreSQL instance is on a remote machine.

...

-port

...

CAST Storage Service/PostgreSQL instance port (default: 2280 - CSS2):

  • For a CAST Storage Service 4, use -port 2284.
  • For a CAST Storage Service 3, use -port 2282.

...

-username

...

CAST Storage Service/PostgreSQL instance username (default: Operator).

...

-database

...

Not used (default: postgres).

...

-exedir

...

Used when you want to run CSSBackup.exe from outside the AIP Core installation folder: allows you to specify the path to the  AIP Core installation folder

...

-compress

...

(boolean: Y or N) Determines whether the resulting backup dump file is compressed or not (default: Y). Setting -compress N is not recommended as the resulting file will be significantly bigger.

...

(Valid in CAST AIP ≥ 8.3.10): Allows the definition of an alternative location (for example, outside the AIP COre installation folder) for the PostgreSQL binaries used for this tool:

  • pg_dump.exe
  • psql.exe
  • pg_restore.exe

For example - this path must not end with a back slash ( \ ):

Code Block
languagetext
-psqlexedir C:\some_folder\pg_binaries
Info
Note that this option should not be needed in the majority of situations.

...

-h

...

Displays a list of available commands.

Result

The result of a successful backup process is the creation of the .cssdmp file specified in the parameter -file. This file can then be used in the restore process (see below).

Supported data types

Ordinarily, the CSSBackup tool will backup a standard CAST AIP schema and all its data. However, if you have customized the schema (by adding new tables or adding new columns to existing tables), you may find that the customizations are not included in the backup result. This can occur when your customizations use data types that are not supported by the CSSBackup process. CAST supports only the following datatypes:

  • integer
  • double precision
  • numeric
  • varchar
  • char
  • timestamp
  • text
  • bytea

If an unsupported data type is encountered during the backup process, the table containing the unsupported data type will be excluded from the backup. A list of excluded tables is displayed in the log file, which you should check on completion of the backup process.

Backing up all CAST AIP schemas in one go

Info
  • When using CSSBackupAll, you must only use CSSRestoreAll to restore your schemas.
  • Schema backups created with CSSBackup/CSSBackupAll included in 8.3.27 (and any higher 8.3 service pack) should only be restored with CSSRestore/CSSRestoreAll included in 8.3.27 (and any higher 8.3 service pack).

In addition to the functions provided by the CSSBackup.exe tool, CAST provides a simple command line based method for backing up ALL CAST AIP schemas in your CAST Storage Service/PostgreSQL instance in one go. This backup can then be used to restore ALL the CAST AIP schemas to the same CAST Storage Service/PostgreSQL instance or to another CAST Storage Service/PostgreSQL instance. As such it is a fully functioning backup, i.e. you do not need to create the target CAST AIP schemas when subsequently running a restore process (see below).

To backup All CAST AIP schemas in one go, locate the file CSSBackupAll.exe. CAST recommends running the backup process from a batch file (make sure that all commands are placed on one single line and remember to surround any paths (i.e. to the .exe, dump file or log file) with quote marks if the path contains spaces). A typical command line to backup all CAST schemas would be as follows:

Code Block
languagetext
CSSBackupAll.exe
-password <Operator_password>
-dumpdir <path_to_the_dump_folder>
-log <path_and_name_of_log_file.log>

Required parameters

set CASTLOGMODE=DEBUG CSSBackupAll.exe -password <Operator_password>

In AIP Core ≥ 8.3.50, an additional text based log file is created in the same folder as specified by the -log option. This log file will be named as follows and contains the PostgreSQL tools log messages:

-password

CAST Storage Service/PostgreSQL instance "operator" password.

-dumpdir

Path to the folder that will store the result of the backup action. This folder must already exist.

-log

Path and name of output log file - does not need to exist already (logging functions in append mode). The resulting file is text based. Note that you can increase logging verbosity by using the parameter set CASTLOGMODE=DEBUG at the start of your command line, e.g.:

Code Block
languagetext
Code Block
<name-of-file-defined-by-"log"-option>.log_<schema-name>_<schema-type>_YYYMMDD8-HHMMSS.txt

If you are using older AIP Core releases that do not provide the additional log file, you can increase logging verbosity by using the parameter set CASTLOGMODE=DEBUG at the start of your command line, e.g.:

Code Block
languagetext
set CASTLOGMODE=DEBUG
CSSBackup.exe
-schema <schema_name>
-password <Operator_password>
-file <path_and_name_of_backup_file.cssdmp>
-log <path_and_name_of_log_file.log>


Additional optional parameters

-host

Name/IP address of machine hosting the CAST Storage Service/PostgreSQL instance (default: localhost). Only required if the CAST Storage Service/PostgreSQL instance is on a remote machine.

-port

CAST Storage Service/PostgreSQL instance port (default: 2280 - CSS2):

  • For a CAST Storage Service 4, use -port 2284.
  • For a CAST Storage Service 3, use -port 2282.

-username

CAST Storage Service/PostgreSQL instance username (default: Operator).

-database

Use this option if you need to connect to a CAST Storage Service/PostgreSQL instance that uses a custom database (i.e. not the default "postgres"). If the option is omitted, the default database name will be used ("postgres").

-logtimeRequires AIP Core ≥ 8.3.50. Use this option to toggle the use of timestamps in all log files. By default this option is active. To disable it, use -logtime-
-verboseRequires AIP Core ≥ 8.3.50. Use this option to toggle verbose log messages, specifically log messages generated by the PostgreSQL (pg_dump/pg_restore). By default this option is disabled. To activate it, use -verbose. When enabled, verbose log messages are written to the <schema-name>_<schema-type>.log_<schema-name>_<schema-type>_YYYMMDD8-HHMMSS.txt file located in the same folder as specified by the -log option.

-exedir

Used when you want to run CSSBackup.exe from outside the AIP Core installation folder: allows you to specify the path to the  AIP Core installation folder

-compress

(boolean: Y or N) Determines whether the resulting backup dump file is compressed or not (default: Y). Setting -compress N is not recommended as the resulting file will be significantly bigger.

-psqlexedir  

Requires AIP Core ≥ 8.3.10. Allows the definition of an alternative location (for example, outside the AIP COre installation folder) for the PostgreSQL binaries used for this tool:

  • pg_dump.exe
  • psql.exe
  • pg_restore.exe

For example - this path must not end with a back slash ( \ ):

Code Block
languagetext
-psqlexedir C:\some_folder\pg_binaries

Info
Note that this option should not be needed in the majority of situations.


-h

Displays a list of available commands.

Result

The result of a successful backup process is the creation of the .cssdmp file specified in the parameter -file. This file can then be used in the restore process (see below).

Supported data types

Ordinarily, the CSSBackup tool will backup a standard CAST AIP schema and all its data. However, if you have customized the schema (by adding new tables or adding new columns to existing tables), you may find that the customizations are not included in the backup result. This can occur when your customizations use data types that are not supported by the CSSBackup process. CAST supports only the following datatypes:

  • integer
  • double precision
  • numeric
  • varchar
  • char
  • timestamp
  • text
  • bytea

If an unsupported data type is encountered during the backup process, the table containing the unsupported data type will be excluded from the backup. A list of excluded tables is displayed in the log file, which you should check on completion of the backup process.

Backing up all CAST AIP schemas in one go

Info
  • When using CSSBackupAll, you must only use CSSRestoreAll to restore your schemas.
  • Schema backups created with CSSBackup/CSSBackupAll included in 8.3.27 (and any higher 8.3 service pack) should only be restored with CSSRestore/CSSRestoreAll included in 8.3.27 (and any higher 8.3 service pack).

In addition to the functions provided by the CSSBackup.exe tool, CAST provides a simple command line based method for backing up ALL CAST AIP schemas in your CAST Storage Service/PostgreSQL instance in one go. This backup can then be used to restore ALL the CAST AIP schemas to the same CAST Storage Service/PostgreSQL instance or to another CAST Storage Service/PostgreSQL instance. As such it is a fully functioning backup, i.e. you do not need to create the target CAST AIP schemas when subsequently running a restore process (see below). Starting AIP Core 8.3.50, this tool can also be used (via the -schemas option) to backup specific named schemas (instead of all of them).

To use the tool, locate the file CSSBackupAll.exe. CAST recommends running the backup process from a batch file (make sure that all commands are placed on one single line and remember to surround any paths (i.e. to the .exe, dump file or log file) with quote marks if the path contains spaces). A typical command line to backup all CAST schemas would be as follows:

Code Block
languagetext
CSSBackupAll.exe
-password <Operator_password>
-dumpdir <path_to_the_dump_folder>
-log <path_and_name_of_log_file.log>

...

...

Required parameters

(Valid in CAST AIP ≥ 8.3.10): Allows the definition of an alternative location (for example, outside the AIP Core installation folder) for the PostgreSQL binaries used for this tool:

  • pg_dump.exe
  • psql.exe
  • pg_restore.exe

For example - this path must not end with a back slash ( \ ):

-hostName/IP address of machine hosting the password

CAST Storage Service/PostgreSQL instance (default: localhost). Only required if the CAST Storage Service/PostgreSQL instance is on a remote machine.

-port

CAST Storage Service/PostgreSQL instance port (default: 2280 - CSS2):

  • For a CAST Storage Service 4, use -port 2284.
  • For a CAST Storage Service 3, use -port 2282.

-username

CAST Storage Service/PostgreSQL instance username (default: Operator).

-database

Not used (default: postgres).

-exedir

Used when you want to run CSSBackupAll.exe from outside the AIP Core installation folder: allows you to specify the path to the AIP Core installation folder

-compress

(boolean: Y or N) Determines whether the resulting backup dump files are compressed or not (default: Y). Setting -compress N is not recommended as the resulting file will be significantly bigger.

-psqlexedir  
Code Block
languagetext
-psqlexedir C:\some_folder\pg_binaries
Info
Note that this option should not be needed in the majority of situations.

-h

Displays a list of available commands.

Result

The result of a successful backup process is the creation of the multiple .backup files in the folder specified in the -dumpdir parameter. The contents of this folder can then be used in the "restore all" process (see below).

Restoring a backed up CAST AIP schema

Info

 The CSSRestore release number (i.e. the AIP Core release) must be the same or higher than the CSSBackup release (i.e. the AIP Core release) used to backup the schemas.

CAST provides a simple command line based method for restoring any CAST AIP schema to your CAST Storage Service that has been backed up using the CSSBackup.exe tool documented above.

To restore a CAST schema, locate the file CSSRestore.exe. CAST recommends running the restore process from a batch file (make sure that all commands are placed on one single line and remember to surround any paths (i.e. to the .exe, dump file or log file) with quote marks if the path contains spaces). A typical command line to restore one CAST AIP schema would be as follows:

Code Block
languagetext
CSSRestore.exe
-schema <schema_name>
-password <Operator_password>
-file <path_and_name_of_backup_file.cssdmp>
-log <path_and_name_of_log_file.log>

Required parameters

...

-schema

...

Name of CAST AIP schema to restore. The schema is created if it does not already exist. If the schema exists already, the restore will fail.

...

-password

...

CAST Storage Service/PostgreSQL instance "operator" password.

...

-file

...

Path and name of backup dump file, using the .cssdmp extension.

...

-log

Path and name of output log file - does not need to exist already (logging functions in append mode). The resulting file is text based. Note that you can increase logging verbosity by using the parameter set CASTLOGMODE=DEBUG at the start of your command line, e.g.:

Code Block
languagetext
set CASTLOGMODE=DEBUG
CSSRestore.exe
-schema <schema_name>
-password <Operator_password>
-file <path_and_name_of_backup_file.cssdmp>
-log <path_and_name_of_log_file.log>

Additional optional parameters

...

-host

...

Name/IP address of machine hosting the CAST Storage Service/PostgreSQL instance (default: localhost). Only required if the CAST Storage Service/PostgreSQL instance is on a remote machine.

...

-port

...

CAST Storage Service/PostgreSQL instance port (default: 2280 - CSS2):

  • For a CAST Storage Service 4, use -port 2284.
  • For a CAST Storage Service 3, use -port 2282.

...

-username

...

CAST Storage Service/PostgreSQL instance username (default: Operator).

...

-database

...

Not used (default: postgres).

...

-exedir

...

Used when you want to run CSSRestore.exe from outside the AIP Core installation folder: allows you to specify the path to the AIP Core installation folder

...

(Valid in CAST AIP ≥ 8.3.10): Allows the definition of an alternative location (for example, outside the AIP Core installation folder) for the PostgreSQL binaries used for this tool:

  • pg_dump.exe
  • psql.exe
  • pg_restore.exe

For example - this path must not end with a back slash ( \ ):

Code Block
languagetext
-psqlexedir C:\some_folder\pg_binaries
Info
Note that this option should not be needed in the majority of situations.

...

-h

...

Displays a list of available commands.

Result

The result of a successful restore process is a fully functioning CAST AIP schema that can be used immediately.

Note

It is often useful to optimize the CAST AIP schema you've just restored. See Optimizing CAST schemas.

Restoring all backed up CAST AIP schemas in one go

Info

The CSSRestoreAll release (i.e. the AIP Core release) must be the same or higher than the CSSBackupAll release (i.e. the AIP Core release) used to backup the schemas.

In addition to the functions provided by the CSSRestore.exe tool, CAST provides a simple command line based method for restoring ALL CAST AIP schemas to your CAST Storage Service/PostgreSQL instance that have been backed up using the CSSBackupAll.exe tool documented above.

To restore All CAST AIP schemas, locate the file CSSRestoreAll.exe. CAST recommends running the restore process from a batch file (make sure that all commands are placed on one single line and remember to surround any paths (i.e. to the .exe, dump file or log file) with quote marks if the path contains spaces). A typical command line to restore all CAST AIP schemas would be as follows:

Code Block
languagetext
CSSRestoreAll.exe
-password <Operator_password>
-dumpdir <path_to_the_dump_folder>
-log <path_and_name_of_log_file.log>

Required parameters

...

-password

...

CAST Storage Service/PostgreSQL instance "operator" password.

...

-dumpdir

...

Path to the folder containing the result of the "backup all" action.

...

-log

Path and name of output log file - does not need to exist already (logging functions in append mode). The resulting file is text based. Note that you can increase logging verbosity by using the parameter set CASTLOGMODE=DEBUG at the start of your command line, e.g.:

Code Block
languagetext
set CASTLOGMODE=DEBUG
CSSRestoreAll.exe
-password <Operator_password>
-dumpdir <path_to_the_dump_folder>
-log <path_and_name_of_log_file.log>

Additional optional parameters

(Valid in CAST AIP ≥ 8.3.10): Allows the definition of an alternative location (for example, outside the AIP Core installation folder) for the PostgreSQL binaries used for this tool:

  • pg_dump.exe
  • psql.exe
  • pg_restore.exe

For example - this path must not end with a back slash ( \ ):

-host

Name/IP address of machine hosting the CAST Storage Service/PostgreSQL instance (default: localhost). Only required if the CAST Storage Service/PostgreSQL instance is on a remote machine.

-port

CAST Storage Service/PostgreSQL instance port (default: 2280 - CSS2):

  • For a CAST Storage Service 4, use -port 2284.
  • For a CAST Storage Service 3, use -port 2282.

-username

CAST Storage Service/PostgreSQL instance username (default: Operator).

-database

Not used (default: postgres).

-exedir

Used when you want to run CSSRestoreAll.exe from outside the AIP Core installation folder: allows you to specify the path to the AIP Core installation folder

-psqlexedir
Code Block
languagetext
-psqlexedir C:\some_folder\pg_binaries
InfoNote that this option should not be needed in the majority of situations

"operator" password.

-dumpdir

Path to the folder that will store the result of the backup action. This folder must already exist. All schemas will be backed up using the .backup file extension.

-log

Path and name of output log file - does not need to exist already (logging functions in append mode). The resulting file is text based. In AIP Core ≥ 8.3.50, additional text based log files are created in the same folder as specified by the -log option (one per schema). These log files will be named as follows and contain the PostgreSQL tools log messages:

Code Block
<name-of-file-defined-by-"log"-option>.log_<schema-name>_<schema-type>_YYYMMDD8-HHMMSS.txt

If you are using older AIP Core releases that do not provide the additional log file, you can increase logging verbosity by using the parameter set CASTLOGMODE=DEBUG at the start of your command line, e.g.:

Code Block
languagetext
set CASTLOGMODE=DEBUG
CSSBackupAll.exe
-password <Operator_password>
-dumpdir <path_to_the_dump_folder>
-log <path_and_name_of_log_file.log>


Additional optional parameters

-host

Name/IP address of machine hosting the CAST Storage Service/PostgreSQL instance (default: localhost). Only required if the CAST Storage Service/PostgreSQL instance is on a remote machine.

-port

CAST Storage Service/PostgreSQL instance port (default: 2280 - CSS2):

  • For a CAST Storage Service 4, use -port 2284.
  • For a CAST Storage Service 3, use -port 2282.

-username

CAST Storage Service/PostgreSQL instance username (default: Operator).

-database

Use this option if you need to connect to a CAST Storage Service/PostgreSQL instance that uses a custom database (i.e. not the default "postgres"). If the option is omitted, the default database name will be used ("postgres").

-logtimeRequires AIP Core ≥ 8.3.50. Use this option to toggle the use of timestamps in all log files. By default this option is active. To disable it, use -logtime-
-verboseRequires AIP Core ≥ 8.3.50. Use this option to toggle verbose log messages, specifically log messages generated by the PostgreSQL (pg_dump/pg_restore). By default this option is disabled. To activate it, use -verbose. When enabled, verbose log messages are written to the <schema-name>_<schema-type>.log_<schema-name>_<schema-type>_YYYMMDD8-HHMMSS.txt file located in the same folder as specified by the -log option.

-exedir

Used when you want to run CSSBackupAll.exe from outside the AIP Core installation folder: allows you to specify the path to the AIP Core installation folder

-compress

(boolean: Y or N) Determines whether the resulting backup dump files are compressed or not (default: Y). Setting -compress N is not recommended as the resulting file will be significantly bigger.

-psqlexedir  

Requires AIP Core ≥ 8.3.10. Allows the definition of an alternative location (for example, outside the AIP Core installation folder) for the PostgreSQL binaries used for this tool:

  • pg_dump.exe
  • psql.exe
  • pg_restore.exe

For example - this path must not end with a back slash ( \ ):

Code Block
languagetext
-psqlexedir C:\some_folder\pg_binaries

Info
Note that this option should not be needed in the majority of situations.


-parallel

Requires AIP Core ≥ 8.3.50. Use this option to define multiple CPU threads to increase job performance. By default this option is not active therefore one single thread is used. Using the option -parallel on its own will use three threads. To use additional threads, define the number you require, for example -parallel 5 to use five threads.

Note
Note that the tool does not impose any limits on thread numbers, however I high thread number could use up all resources while the job is being actioned.


-schemas

Requires AIP Core ≥ 8.3.50. Use this option to define the schemas you wish to backup, rather than backing up ALL schemas on the instance. Schemas to backup must be provided in a comma separated list, for example:

Code Block
languagetext
-schemas general_measure,app1_local,app1_central,app2_local,app22_mngt,app3_central


-h

Displays a list of available commands.

Result

The result of a successful backup process is the creation of the multiple .backup files in the folder specified in the -dumpdir parameter. The contents of this folder can then be used in the "restore all" process (see below).

Restoring a backed up CAST AIP schema

Info

 The CSSRestore release number (i.e. the AIP Core release) must be the same or higher than the CSSBackup release (i.e. the AIP Core release) used to backup the schemas.

CAST provides a simple command line based method for restoring any CAST AIP schema to your CAST Storage Service that has been backed up using the CSSBackup.exe tool documented above.

To restore a CAST schema, locate the file CSSRestore.exe. CAST recommends running the restore process from a batch file (make sure that all commands are placed on one single line and remember to surround any paths (i.e. to the .exe, dump file or log file) with quote marks if the path contains spaces). A typical command line to restore one CAST AIP schema would be as follows:

Code Block
languagetext
CSSRestore.exe
-schema <schema_name>
-password <Operator_password>
-file <path_and_name_of_backup_file.cssdmp>
-log <path_and_name_of_log_file.log>

Required parameters

-schema

Name of CAST AIP schema to restore. The schema is created if it does not already exist. If the schema exists already, the restore will fail.

-password

CAST Storage Service/PostgreSQL instance "operator" password.

-file

Path and name of backup dump file, using the .cssdmp extension.

-log

Path and name of output log file - does not need to exist already (logging functions in append mode). The resulting file is text based. In AIP Core ≥ 8.3.50, an additional text based log file is created in the same folder as specified by the -log option. This log file will be named as follows and contains the PostgreSQL tools log messages:

Code Block
<name-of-file-defined-by-"log"-option>.log_<schema-name>_<schema-type>_YYYMMDD8-HHMMSS.txt

If you are using older AIP Core releases that do not provide the additional log file, you can increase logging verbosity by using the parameter set CASTLOGMODE=DEBUG at the start of your command line, e.g.:

Code Block
languagetext
set CASTLOGMODE=DEBUG
CSSRestore.exe
-schema <schema_name>
-password <Operator_password>
-file <path_and_name_of_backup_file.cssdmp>
-log <path_and_name_of_log_file.log>


Additional optional parameters

-host

Name/IP address of machine hosting the CAST Storage Service/PostgreSQL instance (default: localhost). Only required if the CAST Storage Service/PostgreSQL instance is on a remote machine.

-port

CAST Storage Service/PostgreSQL instance port (default: 2280 - CSS2):

  • For a CAST Storage Service 4, use -port 2284.
  • For a CAST Storage Service 3, use -port 2282.

-username

CAST Storage Service/PostgreSQL instance username (default: Operator).

-database

Use this option if you need to connect to a CAST Storage Service/PostgreSQL instance that uses a custom database (i.e. not the default "postgres") - default: postgres.

-logtimeRequires AIP Core ≥ 8.3.50. Use this option to toggle the use of timestamps in all log files. By default this option is active. To disable it, use -logtime-
-verboseRequires AIP Core ≥ 8.3.50. Use this option to toggle verbose log messages, specifically log messages generated by the PostgreSQL (pg_dump/pg_restore). By default this option is disabled. To activate it, use -verbose. When enabled, verbose log messages are written to the <schema-name>_<schema-type>.log_<schema-name>_<schema-type>_YYYMMDD8-HHMMSS.txt file located in the same folder as specified by the -log option.

-exedir

Used when you want to run CSSRestore.exe from outside the AIP Core installation folder: allows you to specify the path to the AIP Core installation folder

-psqlexedir

Requires AIP Core ≥ 8.3.10. Allows the definition of an alternative location (for example, outside the AIP Core installation folder) for the PostgreSQL binaries used for this tool:

  • pg_dump.exe
  • psql.exe
  • pg_restore.exe

For example - this path must not end with a back slash ( \ ):

Code Block
languagetext
-psqlexedir C:\some_folder\pg_binaries

Info
Note that this option should not be needed in the majority of situations.


-h

Displays a list of available commands.

Result

The result of a successful restore process is a fully functioning CAST AIP schema that can be used immediately.

Note

It is often useful to optimize the CAST AIP schema you've just restored. See Optimizing CAST schemas.

Restoring all backed up CAST AIP schemas in one go

Info

The CSSRestoreAll release (i.e. the AIP Core release) must be the same or higher than the CSSBackupAll release (i.e. the AIP Core release) used to backup the schemas.

In addition to the functions provided by the CSSRestore.exe tool, CAST provides a simple command line based method for restoring ALL CAST AIP schemas to your CAST Storage Service/PostgreSQL instance that have been backed up using the CSSBackupAll.exe tool documented above.

To restore All CAST AIP schemas, locate the file CSSRestoreAll.exe. CAST recommends running the restore process from a batch file (make sure that all commands are placed on one single line and remember to surround any paths (i.e. to the .exe, dump file or log file) with quote marks if the path contains spaces). A typical command line to restore all CAST AIP schemas would be as follows:

Code Block
languagetext
CSSRestoreAll.exe
-password <Operator_password>
-dumpdir <path_to_the_dump_folder>
-log <path_and_name_of_log_file.log>

Required parameters

-password

CAST Storage Service/PostgreSQL instance "operator" password.

-dumpdir

Path to the folder containing the result of the "CSSBackupAll" action, i.e. the backed up files.

-log

Path and name of output log file - does not need to exist already (logging functions in append mode). The resulting file is text based. In AIP Core ≥ 8.3.50, additional text based log files are created in the same folder as specified by the -log option (one per schema). These log files will be named as follows and contain the PostgreSQL tools log messages:

Code Block
<name-of-file-defined-by-"log"-option>.log_<schema-name>_<schema-type>_YYYMMDD8-HHMMSS.txt

If you are using older AIP Core releases that do not provide the additional log file, you can increase logging verbosity by using the parameter set CASTLOGMODE=DEBUG at the start of your command line, e.g.:

Code Block
languagetext
set CASTLOGMODE=DEBUG
CSSRestoreAll.exe
-password <Operator_password>
-dumpdir <path_to_the_dump_folder>
-log <path_and_name_of_log_file.log>


Additional optional parameters

-host

Name/IP address of machine hosting the CAST Storage Service/PostgreSQL instance (default: localhost). Only required if the CAST Storage Service/PostgreSQL instance is on a remote machine.

-port

CAST Storage Service/PostgreSQL instance port (default: 2280 - CSS2):

  • For a CAST Storage Service 4, use -port 2284.
  • For a CAST Storage Service 3, use -port 2282.

-username

CAST Storage Service/PostgreSQL instance username (default: Operator).

-database

Use this option if you need to connect to a CAST Storage Service/PostgreSQL instance that uses a custom database (i.e. not the default "postgres"). If the option is omitted, the default database name will be used ("postgres").

-logtimeRequires AIP Core ≥ 8.3.50. Use this option to toggle the use of timestamps in all log files. By default this option is active. To disable it, use -logtime-
-verboseRequires AIP Core ≥ 8.3.50. Use this option to toggle verbose log messages, specifically log messages generated by the PostgreSQL (pg_dump/pg_restore). By default this option is disabled. To activate it, use -verbose. When enabled, verbose log messages are written to the <schema-name>_<schema-type>.log_<schema-name>_<schema-type>_YYYMMDD8-HHMMSS.txt file located in the same folder as specified by the -log option.

-exedir

Used when you want to run CSSRestoreAll.exe from outside the AIP Core installation folder: allows you to specify the path to the AIP Core installation folder

-psqlexedir

Requires AIP Core ≥ 8.3.10. Allows the definition of an alternative location (for example, outside the AIP Core installation folder) for the PostgreSQL binaries used for this tool:

  • pg_dump.exe
  • psql.exe
  • pg_restore.exe

For example - this path must not end with a back slash ( \ ):

Code Block
languagetext
-psqlexedir C:\some_folder\pg_binaries

Info
Note that this option should not be needed in the majority of situations.


-parallel

Requires AIP Core ≥ 8.3.50. Use this option to define multiple CPU threads to increase job performance. By default this option is not active therefore one single thread is used. Using the option -parallel on its own will use three threads. To use additional threads, define the number you require, for example -parallel 5 to use five threads.

Note
Note that the tool does not impose any limits on thread numbers, however I high thread number could use up all resources while the job is being actioned.


-overwriteRequires AIP Core ≥ 8.3.50. Use this option to force existing identically named schemas on the target instance to be dropped when the restore action is run. By default this option is not active and therefore if an identically named schema already exists on the target instance then the entire restore action will fail.
-extensionRequires AIP Core ≥ 8.3.50. Use this option if the folder defined by -dumpdir containing the backed up schemas contains files with multiple different file extensions and you only want to restore files with specific file extensions. By default this option is active with the extension "backup" meaning only files with the extension .backup will be restored. For example you can define -extension schemadump and only files with the .schemadump extension will be restored (anything else is ignored).

-h

Displays a list of available commands.

...

-host

Name/IP address of machine hosting the CAST Storage Service/PostgreSQL instance. (default: localhost).

-port

CAST Storage Service/PostgreSQL instance port (default: 2280 - CSS2):

  • For a CAST Storage Service 4, use -port 2284.
  • For a CAST Storage Service 3, use -port 2282.
-databaseNot used (default: postgresUse this option if you need to connect to a CAST Storage Service/PostgreSQL instance that uses a custom database (i.e. not the default "postgres"). If the option is omitted, the default database name will be used ("postgres").
-username

Name of the CAST Storage Service/PostgreSQL instance user - for example, operator, or a custom user. (default: operator).

Info
Available in CAST AIP ≥ 8.3.13.


-user

CAST Storage Service/PostgreSQL instance username (default: Operator).

Info
This option is deprecated in CAST AIP ≥ 8.3.13 and should not be used. Use -username instead.


-operation

Choose the PostgreSQL operation to perform:

-h

Displays a list of available commands.

...

Anchor
move
move
Move CAST AIP schemas from one instance to another

See Moving existing schemas to a new CAST Storage Service or PostgreSQL instanceCAST schemas.