16.20 - Vendors.config - Teradata SQL Assistant

Teradata® SQL Assistant for Windows User Guide

Product
Teradata SQL Assistant
Release Number
16.20
Published
October 2018
Language
English (United States)
Last Update
2020-01-03
dita:mapPath
gfk1537201040714.ditamap
dita:ditavalPath
ft:empty

This file describes how the application can work with different vendor databases. In general, only modify this file if a customer wants to support a new database that SQL Assistant does not currently support, or if the database settings cause SQL Assistant’s default settings to work incorrectly with that database.

The application never writes to this file.

The following table lists the Vendors.config file properties

Property Description
Key

The first 5 characters of the DbmsName string returned by ODBC.

For an ‘unknown’ vendor database, this string appears in parens after the Data Source name in the Database Explorer Tree. It must be in uppercase.

Name The name to be displayed after the Data Source name in the Explorer Tree.
SQLType

The SQL dialect used by this vendor

This string is used to load the Language and Syntax Example files. It is normally the same as Name, however, there are exceptions. For example, Greenplum uses PostgreSQL.

DBType

A numeric value used for database vendors that are known to SQL Assistant.

Use 0 for unknown, or a value >40 for new data sources.

Catalog

The name of the catalog database, e.g., DBC for Teradata

This database is added to the Database Explorer Tree.

The default is empty (No catalog).

HasRootDB

Specifies whether the DBMS supports multiple Databases

The default is true.

RemoveCmt

Specifies whether /* ... */ style comments must be removed from statements before they are submitted to the database

The default is false.

UpperName

Specifies whether object names must be in upper case for use in catalog functions

The default is false.

UserIsDB

Specifies whether a User can contain Tables, and so forth.

The default is false.

UseCatalog

Uses the CatalogName parameter in ODBC catalog functions rather than the SchemaName parameter to specify the object container

The default is false.

If the DBType is set to zero (Unknown), this value is overridden by the Use alternate schema... option on the DB Tree tab of the Options dialog.
UseDBPrefix

Specifies whether object names should be prefixed by their container (Database) name when SQL Assistant generates SQL statements

The default is true.

ShowTable

The SQL used to return a table definition

The default is empty.

ShowView

The SQL used to return a view definition

The default is empty.

ShowProc

The SQL used to return a procedure or function definition

The default is empty.

ChangePwd

The SQL used to change the user’s password

The default is empty.

The Change Password menu is not available unless this is provided.

AddDDLPrefix

Specifies whether the SQL used for a Show Definition function includes both prefix and body values. If the value is true, then the SQL for all ShowXxxx properties must return 2 columns. The displayed DDL is the concatenation of these 2 values.

The default is false.

DefaultDB The ‘known’ default database name. Used for vendors who do not return a default database through ODBC.
Use3PartNames Specifies that the vendor uses BOTH catalog AND Schema fields in their catalog functions.
DefaultSchema This is the default schema to be used when the vendor uses 3 part names.

Some of the strings used in this file can contain variables for which object names, or types, need to be substituted. The recognized variable names are described below:

[db] The Database Name, or object container name (Catalog, Schema, and so forth)
[obj] The object name (Table, View, Procedure or Function)
[user] The current user name
[oldpwd] The current password for the user
[pwd] The new password you wish to set
[type] The object type (Procedure or Function)
[olddb]

The current database name

This is required by some vendors if the object is not in the current database.

In some cases, database compatibility might require changes to the vendor-specific language file. For example, SQL Server allows the administrator to define the characters used to delimit an object name. By default, the system uses the characters ‘[‘ and ‘]’ but it can be changed to use double quotes. In this case, the SqlServer.lng file must be changed to match.