Command-line overview
The name of the Data Protection for SQL Server command-line interface is tdpsqlc.exe. This program is in the directory where Data Protection for SQL Server is installed.
Command-line parameter characteristics
The tdpsqlc executable is followed by high
level operations called commands. Each command
accepts various command line parameters. These parameters consist
of positional parameters and optional
parameters. Specify positional parameters before other
options in the command line. In the following example, the backupcommand
with its database name xyz, the object to
back up, is followed by the type of backup, full,
a positional parameter, and finally by an optional parameter,
/sqlbuffers
tdpsqlc backup xyz full /sqlbuffers=2
Data Protection for SQL Server uses
the following command line syntax:
tdpsqlc command positional parameter 0 or more optional parameters
The command-line parameters have the following
characteristics:
- Positional parameters do not include a leading slash (/) or dash (-).
- Optional parameters can display in any order after the required parameters.
- Optional parameters begin with a forward slash (/) or a dash (-).
- Minimum abbreviations for keywords are indicated in uppercase text.
- All SQL Server names of databases or parts of databases are case-sensitive.
- Some keyword parameters require a value.
- For those keyword parameters that require a value, the value is separated from the keyword with an equal sign (=).
- If a parameter requires more than one value after the equal sign, the values are separated with commas.
- Each parameter is separated from the others by using spaces.
- If a parameter value includes spaces, the value must be enclosed in double quotation marks.
- A positional parameter can display only once per command invocation.
- The following exceptions allow lists of values or repetition of
the parameter:
- FIle=
- Group=
- Log=
- Set=
- /FIles=
- /GRoups=
- /RELocate=
- /RELOCATEDir=
- /TO=
Multiple instances of optional parameters do not need to be contiguous. For example: /files=a /groups=y /files=b /groups=z
Where repeatable syntax exists, multiple values are separated with commas as shown in the following syntax diagram:.-,------. V | >>-TDPSQLC--Backup--+---dbname-+-+----------------------------->< '-*----------'
To select all instances of database names or file names on the server, follow the command with the wildcard asterisk (*). - The following exceptions allow lists of values or repetition of
the parameter: