SAS Base SAS Code - Import - Cloud

Talend Cloud Data Catalog Bridges

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend Data Catalog

Bridge Specifications

Vendor SAS
Tool Name Base SAS Code
Tool Version 9x
Tool Web Site http://support.sas.com/documentation/cdl/en/lrcon/65287/HTML/default/viewer.htm
Supported Methodology [Data Integration] Multi-Model, Data Store (Physical Data Model), (Source and Target Data Stores, Transformation Lineage, Expression Parsing) via SAS TXT File
Incremental Harvesting
Multi-Model Harvesting
Remote Repository Browsing for Model Selection
Data Profiling

SPECIFICATIONS
Tool: SAS / Base SAS Code version 9x via SAS TXT File
See http://support.sas.com/documentation/cdl/en/lrcon/65287/HTML/default/viewer.htm
Metadata: [Data Integration] Multi-Model, Data Store (Physical Data Model), (Source and Target Data Stores, Transformation Lineage, Expression Parsing)
Component: SqlScriptSas version 11.0.0

OVERVIEW
This bridge parses a directory of SAS code scripts to extract the data models of their source and target data stores (e.g. database schema, tables, columns) as well as the Data Integration (DI/ETL/ELT) models for the data flow lineage between these data stores.

The import process consists of multiple stages including SAS code interpretation that allows to extract and prepare the SQL statements for further analysis. In SAS code, the SQL queries are located inside procedure called 'PROC SQL'. The interpreter also helps to convert SAS specific expressions into the generic structures that can be recognized by the SQL parser.
This bridge allows to replace SAS variables (e.g. &var.) in SQL queries using a separate file that contains all the necessary values. For more details please refer to documentation for bridge parameter 'Miscellaneous' and the section for key '-s'.

REQUIREMENTS
n/a

FREQUENTLY ASKED QUESTIONS
n/a

LIMITATIONS
Refer to the current general known limitations at http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html

SUPPORT
Provide a trouble shooting package with:
- the debug log (can be set in the UI or in conf/conf.properties with MIR_LOG_LEVEL=6)
- the metadata backup if available (can be set in the Miscellaneous parameter with option -backup)


Bridge Parameters

Parameter Name Description Type Values Default Scope
Directory The directory of SAS code files to import. DIRECTORY     Mandatory
Directory Filter Specify a search filter for the sub directories. Use regular expressions in java format if needed (e.g. '
.*_script - only directories ending with _script
directory1 directory2 - multiple conditions can be defined by using a space as a separator
\"my directory\" - names with with any space must be escaped with double quotes
-ddl - Negation can be defined with the preceding dash character
STRING      
File Filter The file filter pattern, based on the using the java format expression syntax
.*\\.sql - only files with extension .sql
file1 file2 - multiple conditions can be defined by using a space as a separator
\"my file.sql\" - names with with any space must be escaped with double quotes
-\\.tar\\.gz - Negation can be defined with the preceding dash character
STRING      
Miscellaneous INTRODUCTION
Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g.
-connection.cast MyDatabase1="SQL Server"
Some options can be used multiple times if applicable, e.g.
-connection.rename NewConnection1=OldConnection1 -connection.rename NewConnection2=OldConnection2;
As the list of options can become a long string, it is possible to load it from a file which must be located in ${MODEL_BRIDGE_HOME}\data\MIMB\parameters and have the extension .txt. In such case, all options must be defined within that file as the only value of this parameter, e.g.
ETL/Miscellaneous.txt

JAVA ENVIRONMENT OPTIONS
-java.memory <Java Memory's maximum size> (previously -m)
1G by default on 64bits JRE or as set in conf/conf.properties, e.g.
-java.memory 8G
-java.memory 8000M

-java.parameters <Java Runtime Environment command line options> (previously-j)
This option must be the last one in the Miscellaneous parameter as all the text after -java.parameters is passed "as is" to the JRE, e.g.
-java.parameters -Dname=value -Xms1G
The following option must be set when a proxy is used to access internet (this is critical to access https://repo.maven.apache.org/maven2/ (and exceptionally a few other tool sites) in order to download the necessary third party software libraries.
-java.parameters -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass -Dhttps.proxyUser=user -Dhttps.proxyPassword=pass

-java.executable <Java Runtime Environment full path name> (previously -jre)
It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g.
-java.executable "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe"

-environment.variable <Environment variable value> (previously -v)
None by default, e.g.
-environment.variable var1=value1 -environment.variable var2="value2 with spaces"

MODEL IMPORT OPTIONS
-model.name <model name>
Override the model name, e.g.
-model.name "My Model Name"

-prescript <script name>
The script must be located in the bin directory, and have .bat or .sh extension.
The script path must not include any parent directory symbol (..).
The script should return exit code 0 to indicate success, or another value to indicate failure.
For example:
-prescript "script.bat arg1 arg2"

-cache.clear
Clears the cache before the import, and therefore will run a full import without incremental harvesting.
Warning: this is a system option managed by the application calling the bridge and should not be set by users.

-backup <directory>
Full path of an empty directory to save the metadata input files for further troubleshooting.

DATA CONNECTION OPTIONS
Data Connections are produced by the import bridges typically from ETL/DI and BI tools to refer to the source and target data stores they use. These data connections are then used by metadata management tools to connect them (metadata stitching) to their actual data stores (e.g. databases, file system, etc.) in order to produce the full end to end data flow lineage and impact analysis. The name of each data connection is unique by import model. The data connection names used within DI/BI design tools are used when possible, otherwise connection names are generated to be short but meaningful such as the database / schema name, the file system path, or Uniform Resource Identifier (URI). The following options allows to manipulate connections. These options replaces the legacy options -c, -cd, and -cs.

-connection.cast ConnectionName=ConnectionType
Casts a generic database connection (e.g. ODBC/JDBC) to a precise database type (e.g. ORACLE) for SQL Parsing, e.g.
-connection.cast "My Database"="SQL SERVER".
The list of supported data store connection types includes:
ACCESS
CASSANDRA
DB2
DENODO
HIVE
MYSQL
NETEZZA
ORACLE
POSTGRESQL
PRESTO
REDSHIFT
SALESFORCE
SAP HANA
SNOWFLAKE
SQL SERVER
SYBASE
TERADATA
VECTORWISE
VERTICA

-connection.rename OldConnection=NewConnection
Renames an existing connection to a new name, e.g.
-connection.rename OldConnectionName=NewConnectionName
Multiple existing database connections can be renamed and merged into one new database connection, e.g.
-connection.rename MySchema1=MyDatabase -connection.rename MySchema2=MyDatabase

-connection.split oldConnection.Schema1=newConnection
Splits a database connection into one or multiple database connections.
A single database connection can be split into one connection per schema, e.g.
-connection.split MyDatabase
All database connections can be split into one connection per schema, e.g.
-connection.split *
A database connection can be explicitly split creating a new database connection by appending a schema name to a database, e.g.
-connection.split MyDatabase.schema1=MySchema1

-connection.map DestinationPath=SourcePath
Maps a source path to destination path. This is useful for file system connections when different paths points to the same object (directory or file).
On Hadoop, a process can write into a CSV file specified with the HDFS full path, but another process reads from a HIVE table implemented (external) by the same file specified using a relative path with default file name and extension, e.g.
-connection.map hdfs://host:8020/users/user1/folder/file.csv=/user1/folder
On Linux, a given directory (or file) like /data can be referred to by multiple symbolic links like /users/john and /users/paul, e.g.
-connection.map /users/John=/data -connection.map /users/paul=/data
On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g.
-connection.map M:\=C:\data -connection.map N:\=C:\data

ETL POST PROCESSING OPTIONS
These options are available on all ETL/DI tools and scripting import bridges in order to:
- Process all SQL parsing
- Build run time models from design models and runtime variables
- Calculate run time summary lineage

-ppus
etl.summary.add.ultimate
Adds the ultimate runtime lineage summary (which can generate a very large model).

-ppsp
etl.summary.only.ultimate
Only produces the ultimate runtime lineage summary (which can generate a very large model).

-pppd
etl.connections.add.internal.design
Adds the internal ETL design data connectors (needed for ETL conversion).

-ri
etl.connections.remove.input
Removes all input (source) data connections (to reduce the size of the generated model).

SQL DML OPTIONS
-s <filepath>
Path to a file that resolves Shell parameters in either Windows (%param%) or in Linux (${param}, $1) format. This parameter can be used to define a path to the key/value pair yaml file. The path can be escaped with double quotes if it contains spaces or any special characters. The records from the file will be used to preprocess the scripts and replace the corresponding Shell parameters with the actual values. The key literals must not be decorated with the escape characters and the matching rules are case sensitive. Character colon ':' is used as a key/value pair delimiter and must be escaped with backward slash '\' if it is part of the parameter name. For example, for script 'INSERT INTO %SCHEMA1%.t1(c1) SELECT a from %SCHEMA2%.t2;' the file with the parameters can be organized in the following way. E.g.
# common shell parameter map
SCHEMA1: actual_schema1
SCHEMA2: actual_schema2
# individual script maps
"D:\\MIMB\\hive_001.hql":
${table_name}: actual_table
"D:\\MIMB\\hive_002.hql":
${year_var}: 1993

If the bridge doesn't find yaml file then it generates new one and fills it with pairs of keys/default values.
Yaml file contains "common shell parameter map" section and "individual script maps" section. The bridge takes common key/value pairs to substitute shell parameters by its values in all scripts. The section "individual script maps" contains pairs for individual scripts.

SQL SCRIPT OPTIONS
-d
Default schema. Allows to specify a schema name for the objects that don't have it defined explicitly.

-e
Encoding. This value will be used to load text from the specified script files. By default, UTF-8 will be used. E.g.
-e UTF-16
-e UTF-16BE
-e US-ASCII

-cs
Create separate connections for all database schemas
-cs c1, c2 - create separate connections for all database schemas of 'c1' and 'c2' connections
-cs app1=c.s1 - create 'app1' connection for the 's1' schema in the 'c' connection
STRING      

 

Bridge Mapping

Mapping information is not available