dssadapt - DSS 6 | Data Source Solutions Documentation

Documentation: dssadapt - DSS 6 | Data Source Solutions Documentation

dssadapt

Usage

dssadapt [-Rurl][-options] -lloc hub chn

Description

Command dssadapt explores base table definitions in an actual database and compares them with the table information in a channel. It then adapts (either adds, replaces or deletes) the table information in the channel to match the base table definitions by modifying the DSS_COLUMN and DSS_TABLE repository tables.

If a location (-lloc) from where the dssadapt explores the base table definitions contains a table that is not present in the channel but is matched by the 'table filter' statement, then it is added to the channel.
If a table is in the channel but is not matched by the 'table filter' statement, then it is deleted from the channel.
if a table is both matched by the 'table filter' statement and included in the channel but has incorrect column information in the channel, then this column information is updated.
If a 'table filter' statement is not supplied, then tables are not added or deleted; only the existing column information is updated where necessary.

Command dssadapt corresponds to the Table Selection dialog in the User Interface.

Options

This section describes the options available for command dssadapt.

Parameter	Description
`-a`	Add new tables to the channel. This option will not re-describe the tables that are already in the channel. In the User Interface, this option corresponds to the Table Selection dialog.
`-d`	Delete any tables from channel that are not available in the database. In the User Interface, this option corresponds to the Table Selection dialog.
`-ffname`	Write (append) a list of modified or added table names to file `fname`. This option can be useful in a script which calls dssadapt and then does extra steps (for example, run dssrefresh) for tables which were affected (see example shell script to run dssadapt).
`-ggrpname`	Assign table group name `grpname` for the tables being added. The `default` table group name is GENERAL. This option cannot be used in combination with option `-G`. In the User Interface, this option corresponds to the Group name option in the Table Selection dialog.
`-G`	Assign dynamic group name from schema. When tables are being added to the channel, the table's schema name is assigned as the table's group name. If tables are selected from multiple schemas, then each table will be assigned to the respective table group named corresponding to its schema name. This option cannot be used in combination with option `-g`. In the User Interface, this option corresponds to the Auto-assign schema as group name option in the Table Selection dialog.
`-iletters`	Ignore certain differences. Value for `letters` can contain: c - Column was dropped. C - Column was added. d - Data type changed. D - Data type family changed. f - Column range became smaller. F - Column range became bigger. h - Distribution key removed. H - Distribution key added. k - Unique index removed. K - Unique index added. n - Nullability removed. N - Nullability added. s - Encoding changed.
`-I`	Ignore data type localization before comparing. This option controls whether DSS should convert the repository data types into data types that could be created in the DBMS. If supplied, dssadapt will not convert data types to the native data types of the database. If not supplied, then the data types are converted before they are compared.
`-lloc`	Specifies the adapt location loc, typically the capture location of a channel.
`-mmapdocs`	Specifies a table filter statement for defining which base tables in the database should be included (or excluded) in the channel. The table filter statement can contain names of a schema, table, column and/or a pattern (such as mytbl*). Multiple table filter statements can be supplied in a single command. The table filter statement can be supplied inline or as a file `mapdocs` that contains the table filter statement(s) for a channel. When supplying the file name, the input must start with a @, e.g., `dssadapt -m @mapdocs.txt`. For more information about the syntax for table filter statement, see sections Syntax for Table Filtering and Syntax for SAP Table Filtering.
`-Rurl`	Remote hub server. Access the hub server running on a remote machine, via the REST interface. This option is required for remote CLI access. When using this option, command dsslogin should be run first, for authentication.
`-ttbls`	Re-describe only specific tables `tbls`. This option will not add new tables to the channel.
`-V`	Show views and materialized views. For Oracle, the materialized views are always shown. In the User Interface, this option corresponds to the Show views checkbox in the Table Selection dialog.
`-x`	Check-only mode. Do not apply any changes to the repository tables.

Table Filtering

Command dssadapt supplied with table filter statement allows you to define which base tables in the adapt location should be included in or excluded from the channel. Only tables matching any of the given statement will be included or excluded.

Syntax for Table Filtering

This section describes the syntax for filtering tables. The syntax for filtering SAP tables is described in section Syntax for SAP Table Filtering.

[<em>schema</em><b>.</b>]<em>tablename</em>

[<em>schema</em><b>.</b>]<em>tablename</em> [<b>-</b><em>tablename</em>]<b>...</b>

Value schema can be a literal only and value tablename can be a literal or pattern. Pattern matching can be done using the special symbols *, ? or [characters]. The table name must be enclosed in double quotes if the table name contains a space, a special character (*, ?, /), or a new line. Since DSS 6.1.0/13, if the table name contains the special character /, then it is not required to enclose the table name in double quotes.
Special symbol - is used to define negative patterns. Tables matching the negative pattern are excluded from the preceding pattern's result. In the following example, the filter selects all tables whose name begins with t, but excludes all tables whose name begins with tmp or ends with _temp.
```
t* -tmp* -*_temp
```

Empty lines and comments (e.g. # Test) are ignored.

Examples for Filtering Tables and Schemas

Most of the examples listed in this section are in the table filter file format.

tbl1                 # Match table named 'tbl1' in default schema.

schema1.*            # Match all tables in 'schema1'.

schema2.tbl1         # Match table named 'tbl1' in 'schema2'.

history_*            # Match all tables whose name begins with 'history_' in default schema.

"my table"           # Match table named "my table" in default schema. Use double quotes
                     # if there is a space in table name.

A shell script as shown in section Shell Script to Run dssadapt can be created to run dssadapt for checking new or modified tables in a location.

Syntax for SAP Table Filtering

This section describes the syntax for filtering SAP tables. The syntax for filtering non-SAP tables is described in section Syntax for Table Filtering.

<em>tablename </em>[<b>-</b><em>tablename</em>]<b>...</b>

<em>tablename</em>

Value tablename can be a literal or a pattern. Pattern matching can be done (only for tables) using the special symbols *, ? or [characters]. For DSS versions up to 6.1.0/12, if the table name contains the special character /, then the table name must be enclosed in double quotes.
Special symbol - is used to define negative patterns. Tables matching the negative pattern are excluded from the preceding pattern's result. In the following example, the filter selects all tables whose name begins with t, but excludes all tables whose name begins with tmp or ends with _temp.
```
t* -tmp* -*_temp
```

Empty lines and comments (e.g. # Test) are ignored.

Examples for Filtering SAP Tables

mara                 # Match table named 'mara' from all modules.

mar*                 # Match all tables whose name begins with 'mar' from all modules.

"/bev1/lut906"       # Match table named '/bev1/lut906' from all modules.
                     # Use double quotes if there is a slash in table name.

Shell Script to Run dssadapt

A shell script can be created to run dssadapt for checking new or modified tables in a location.

The following example demonstrates the use of a shell script to run dssadapt for checking new or modified tables in location loc1 and if any new or modified tables are found in location loc1, the script executes the necessary commands to enroll the tables into the channel mychn.

#!/bin/sh
hub=myhub                                           # Hub name
chn=mychn                                           # Channel name
src=loc1                                            # Source location name
F=/tmp/adapt_$chn.out                               # File where dssadapt writes list of new or changed tables
dssadapt -f$F -m@/tmp/adapt.tmpl -l$src $hub $chn   # Add new or changed tables from source to channel based on the
                                                    # patterns defined in the pattern file.

if test -f $F                                       # If file $F exists then new or changed tables were detected
then
    dsssuspend $hub $chn-integ                      # Suspend integrate jobs
    dssactivate -oelj $hub $chn                         # Regenerate supplemental-logging, jobs and enroll info
    dssrefresh -r$src -t@$F -qrw -cbkr $hub $chn    # Re-create and online refresh tables in file $F
    dssstart -u -r $hub $chn-integ                  # Re-trigger suspended jobs
    dssadapt -x -l$src $hub $chn                    # Double-check channel now matches target location (optional)    

    rm $F                                           # Remove file with list of new or changed tables
fi