Bridge Specifications
| Vendor | SAP |
| Tool Name | Sybase ASE Database |
| Tool Version | 15 |
| Tool Web Site | http://www.sap.com/pc/tech/database/software/adaptive-server-enterprise/index.html |
| Supported Methodology | [Relational Database] Multi-Model, Data Store (Physical Data Model, Stored Procedure Expression Parsing) via JDBC API |
SPECIFICATIONS
Tool: SAP / Sybase ASE Database version 15 via JDBC API
See http://www.sap.com/pc/tech/database/software/adaptive-server-enterprise/index.html
Metadata: [Relational Database] Multi-Model, Data Store (Physical Data Model, Stored Procedure Expression Parsing)
Component: JdbcSybase version 11.1.0
OVERVIEW
This bridge uses a JDBC connection to a SAP Sybase ASE database server to extract all its metadata (e.g. Schemas, Tables, Columns, Data Types.) and parse any SQL (e.g. Views, Stored Procedures)to produce the data flow lineage.
This bridge imports the database server metadata as multi models with one model per schema. Further imports (incremental harvesting) will detect changes in schema to only import changed schemas (reusing already harvested unchanged schemas).
REQUIREMENTS
See the driver Location parameter for any JDBC driver requirements.
See the User parameter for any user permission requirements.
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
This bridge does not currently support the latest version of the Sybase database, as the driver should implement the 'com.sybase.jdbc3.jdbc.SybDriver' class and it appears there is no suitable driver available from SAP. In this case, one should utilize the Generic JDBC bridge to import metadata from Sybase.
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 | |||
| Driver location | The JDBC driver folder location where all found JAR files will be added to the CLASSPATH. The SAP Sybase ASE JDBC driver default location is: ${MODEL_BRIDGE_HOME}/java/Jdbc/sybase The 'com.sybase.jdbc4.jdbc.SybDriver' JDBC driver with the 'jConnect (TM) for JDBC (TM)' name is required. JDBC DRIVER DETAILS - driver name: Sybase jConnect (com.sybase.jdbc4.jdbc.SybDriver) - driver version: http://infocenter.sybase.com/help/index.jsp?topic=/com.sybase.infocenter.dc01776.1604/doc/html/san1357754912881.html - files: jconn4.jar |
DIRECTORY | ||||||
| Host | The host name used by JDBC to connect to the database server (localhost by default) e.g. MyDatabaseServer.com or its IP address, e.g. 192.169.1.2 or its full qualified JDBC connection string, e.g. jdbc:sybase:Tds:COMPUTER_NAME_OR_IP:PORT |
STRING | localhost | Mandatory | ||||
| Port | The port used by JDBC to connect to the database server (5000 by default for SAP Sybase ASE). This parameter is ignored if the Host parameter is based on a fully qualified JDBC connection string that includes the port. |
NUMERIC | 5000 | Mandatory | ||||
| User | The user name used by JDBC to connect to the database server. This parameter is ignored if the Host parameter is based on a fully qualified JDBC connection string that includes the user name. USER PERMISSIONS As with any other bridges, this bridge is warranted to be read only and only extracts metadata. Therefore the user of this bridge requires much less permissions than classic users needing to read/write data. However, this bridge needs a user with (read only) access to system tables in order to access advanced metadata such as the SQL of views or stored procedures which are not implemented in the metadata portion of the JDBC driver, therefore the Database Administrator (DBA) needs to be involved in order get the proper user with enough permissions. Note that there are no specific instructions as to what are the minimal set of permissions required as it varies from different database types and versions. In order to ensure that this bridge is working properly, one must first import using this bridge with a FULL Sys Admin type username (all permissions), i.e., the same type of username that is used to create and maintain the DB. Once this bridge is working properly against a given DB, then the DBA may create a user with lesser privileges that still produce a successful result. |
STRING | ||||||
| Password | The user password used by JDBC to connect to the database server. | PASSWORD | ||||||
| Database | The name of the database instance to import. | REPOSITORY_MODEL | Mandatory | |||||
| Schema | The subset of schemas to import expressed as a semicolon separated list of schemas, e.g. schema1; schema2 All user schemas are imported if that list is empty. All system schemas (e.g. SysAdmin) and objects are ignored by default. If system schemas are needed, use the Miscellaneous parameter option -s. Schema name patterns using a SQL like expression syntax: - Inclusion syntax: using '%, e.g. A%; %B; %C%; D - start with A or - end with B or - contain C or - equal D - Exclusion syntax: using 'NOT", e.g. A%; %B; NOT %SYS; NOT 'SYS%' - where (name like A% or name like %B) - and (name NOT like %SYS) - and (name NOT like 'SYS%') - Special characters: using single quote, e.g. OneWord%; 'Two Words%' |
REPOSITORY_SUBSET | ||||||
| Tables and views | The subset of tables to import expressed as a semicolon separated list of tables, e.g. table1; table2 All user tables are imported if that list is empty. All system tables (e.g. SysAdmin) and objects are ignored by default. If system tables are needed, use the Miscellaneous parameter option -s. Table name patterns using a SQL like expression syntax: - Inclusion syntax: using '%, e.g. A%; %B; %C%; D - start with A or - end with B or - contain C or - equal D - Exclusion syntax: using 'NOT", e.g. A%; %B; NOT %SYS; NOT 'SYS%' - where (name like A% or name like %B) - and (name NOT like %SYS) - and (name NOT like 'SYS%') - Special characters: using single quote, e.g. OneWord%; 'Two Words%' |
STRING | ||||||
| Stored procedure details | Controls the amount of details imported from stored procedures: 'Signature' The name and parameters of stored procedures 'Code, signature' The above plus code 'None' stored procedure details are not included. |
ENUMERATED |
|
Signature | ||||
| Import indexes | Controls the import of Indexes: 'False' Indexes are not imported 'True' Indexes are imported |
BOOLEAN |
|
False | ||||
| 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. Note: The majority of proxies are concerned with encrypting (HTTPS) the outside (of the company) traffic and trust the inside traffic that can access proxy over HTTP. In this case, an HTTPS request reaches the proxy over HTTP where the proxy HTTPS-encrypts it. -java.parameters -java.parameters -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.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 <name>=<value> (previously -v) None by default, e.g. -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 OldPath=NewPath Maps a New to Old 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 -connection.casesensitive ConnectionName Overrides the default case insensitive matching rules for the object identifiers inside the specified connection, provided the detected type of the data store by itself supports this configuration (e.g. Microsoft SQL Server, MySql etc.), e.g. -connection.casesensitive "My Database" JDBC DATABASE OPTIONS -system.objects.import (previously -s) Imports all system objects (that are skipped by default). -synonyms.ignore (previously -synonyms) Ignores the synonyms when importing, therefore reducing the size of the model when a large number synonyms exisit. -data.dictionary.server <database identification name> (previously -server.name) Sets a server name for the data dictionary to use for extracting tables and view definitions. In a multitenant Container Database (CDB), the metadata for data dictionary tables and view definitions is stored only at the root level. However, each Pluggable Database (PDB) has its own set of data dictionary tables and views for the database objects contained in the PDB. It is possible that some dba_ views are not available because they are not applicable. -driver.fetch.size <number of rows> (previously -f) The database driver fetch size in number of rows, e.g. -driver.fetch.size 100 -model.split (previously -multiModel) Splits a large database model into multi models (e.g. one schema per model). Warning: this is a system option managed by the application calling this bridge and should not be set by users. -driver.className The full name (including the package name) of the java class that implements the JDBC driver interface. SYBASE DATABASE OPTIONS -parser.double_quoted_identifier provide this option to allow double quoted Sybase identifiers. |
STRING |
Bridge Mapping
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"SAP Sybase ASE Database (via JDBC)" Metamodel JdbcSybase |
Mapping Comments |
| Name | Name | |
| Argument | Procedure Column | The stored procedure parameters are stored in the arguments |
| Description | Comments on the column | |
| Kind | Type | The kind of parameter |
| Name | Name | |
| Association | Exported Keys | |
| Aggregation | True if all the attributes in the Exported Key a+C105re in the Primary Key | |
| AssociationRole | Exported Keys | |
| ExtraConstraint | Update Rule, Delete Rule | |
| Multiplicity | Nullable property of the columns of the Exported Key | |
| Source | Based on the multiplicity of each role | |
| AssociationRoleNameMap | Exported Keys | The rolename map is created if the columns in the primary and foreign keys are different |
| Attribute | Table Column | |
| Comment | Comments on the column | |
| InitialValue | Default value | |
| Name | Name | |
| Optional | Based on the nullable property | |
| PhysicalName | Name | |
| Position | Position | If position is not provided, the order in which the attributes are retrieved is used. |
| BaseType | Types | |
| DataType | Data Type | See datatype conversion array |
| Length | Size | |
| Name | The name is computed from the datatype | |
| PhysicalName | Name | |
| Scale | Maximum scale | |
| CandidateKey | Index, Primary Key | |
| Name | Name | |
| PhysicalName | Name | |
| UniqueKey | Non-Unique property | |
| Class | Table | of type "TABLE" |
| Comment | Comments on the table | |
| CppClassType | Set to ENTITY | |
| CppPersistent | Set to True | |
| Name | Name | |
| PhysicalName | Name | |
| ClassDiagram | Schema | A class diagram is created for each package and contains all the elements of the package |
| DerivedType | Column | Table column, stored procedure column SQL View column or type |
| DataType | Data Type | See datatype conversion array |
| Length | Size | |
| Name | The name is computed from the datatype | |
| PhysicalName | Name | |
| Scale | Decimal digits | |
| UserDefined | True for Type | |
| DesignPackage | Schema | A Package is created for each retrieved schema. If there is no schema a default package is created. |
| Name | Name | Set to "Schema" if there is no schema or the schema has no name. |
| ForeignKey | Exported Keys | |
| Name | Name | |
| PhysicalName | Name | |
| Index | Index, Primary Key, Exported Keys | |
| Clustered | Index type | true if index type is tableIndexClustered |
| Name | Name | |
| PhysicalName | Name | |
| IndexMember | Index Member, Key Member | |
| Position | Position in the Index or key | |
| SortOrder | Ascending/descending order | |
| SQLViewAttribute | View Column | |
| Comment | Comments on the column | |
| Name | Name | |
| PhysicalName | Name | |
| Position | Ordinal position | |
| SQLViewEntity | Table | of type "VIEW" |
| Comment | Comments on the table | |
| Name | Name | |
| PhysicalName | Name | |
| StoreModel | Catalog | The model is built using the elements contained in the catalog (The default catalog used for Teradata) |
| Name | Name | Set to "Catalog". |
| StoredProcedure | Stored Procedure | |
| Description | Comments on the stored procedure | |
| Name | Name |