SQLDriverConnect()およびSQLBrowseConnect()用のキーワード - ODBC Driver for Teradata

ODBC Driver for Teradata® ユーザー ガイド

Product
ODBC Driver for Teradata
Release Number
17.20
Published
2022年6月
Language
日本語
Last Update
2022-08-22
dita:mapPath
ja-JP/uqj1639470627591.ditamap
dita:ditavalPath
ja-JP/nkw1500504256726.ditaval
dita:id
B035-2526
Product Category
Teradata Tools and Utilities

次の表のキーワードは、ODBC Driver for TeradataのSQLDriverConnect()またはSQLBrowseConnect()の接続文字列入力で指定できます。

キーワードでは、英大文字と英小文字の区別はされません。オプションのキーワードには*が付いています。

{ }で囲まれた属性キー値に}文字を含めることはできません。
キーワード 説明
*ACCOUNTSTR=<Account Name>

または

*ACCOUNT=<Account Name>

Teradata DSNのオプションの「odbc.iniファイルで構成できるオプション」というタイトルの表にある“AccountStr=<account>”オプションを参照してください。
*CHARACTERSET=<Character set>

または

*CHARSET=<Character set>

デフォルト = ASCII

Teradata DSNのオプションの“CharacterSet=<charset name>”オプションを参照してください。

DATASOURCEDNSENTRIES=<値>

または

DSDNSENTRIES=<値>

デフォルト = 割り当てなし

Teradata ODBC Driver Advanced Options(Teradata ODBCドライバの詳細オプション)Data Source DNS Entries(データ ソースDNSエントリ)を参照してください。

*DATETIMEFORMAT=[A|I]AA

Teradata DSNのオプションの“DateTimeFormat=[A|I]AAオプションを参照してください。

推奨される設定は、AAA形式(デフォルト)またはIAA形式(オプション)です。整数データ型は、TIME形式では非推奨になったため、推奨されません。詳細については、ODBC Driver for Teradata 16.20以降のバージョンで非推奨になった機能の「整数型時刻」を参照してください。TIMESTAMPを表わす最後の文字は、常にANSIです。

*DEFAULTDATABASE=<database name>

または

*DATABASE=<database name>

データ ソース仕様セクションの“Database=<database name>”オプションを参照してください。
*DBCNAME=123.45.67.89 データ ソース仕様セクションの“DBCName=<IPアドレスか別名>”オプションを参照してください。

この設定は、Teradata Server Info(Teradataサーバー情報)ダイアログ ボックスのODBC Driver Setup(ODBCドライバ セットアップ)セクションで行います。詳細については、ODBCドライバ セットアップの各パラメータを参照してください。

有効なのは、1つの名前またはIPアドレスだけです。名前が指定されている場合、ODBC Driver for Teradataは関連付けられているCOPエントリを自動的に検出します。例えば、名前にCOPxサフィックスが含まれる場合などです。詳細については、COP検出を参照してください。

*DISPKANJICONVERRS=[Y | N] このDSNオプションは無視されます。無効な文字は、代わりの文字に置き換えて使用されます。
*DOMAIN=<Domain Name> (Windowsのみ)サードパーティ サイン オンのためのドメイン名の入力時には、ユーザー名とパスワードもドメイン名とともに入力する必要があります。

ドメイン名を入力しない場合は、ローカル ドメインとみなされます。

*DONTUSEHELPDATABASE=[Y | N]

または

*DONTUSEHELPDB=[Y | N]

デフォルト = No

Teradata DSNのオプションの“DontUseHelpDatabase=[Yes | No]”オプションを参照してください。

*DRIVER=<ODBC Driver for Teradata> データ ソース仕様セクションの“Driver=<ドライバ パス>”オプションを参照してください。
DSN=<DataSourceName> ODBCデータ ソース セクションの“data-source-name=<ドライバ>”オプションを参照してください。
*ENABLEEXTENDEDSTMTINFO=[ Y | N ] デフォルト = Y

Teradata DSNのオプションの“EnableExtendedStmtInfo=[Yes | No]”オプションを参照してください。

*ENABLEREADAHEAD=[ Y | N ] デフォルト = Y

Teradata DSNのオプションの“EnableReadAhead=[Yes | No]”オプションを参照してください。

*ENABLEREDRIVE=[Yes|No|Default] セッションのリクエストがRedriveに関与するかどうか、またはデータベース側のデフォルト値を使用するかを指定します。

デフォルト値は"Default"です。

HTTPS_PORT =<ポート番号> HTTPSのポート番号

デフォルト = 443

データベースにアクセスするためにTLS接続で使用されるポート番号を指定します。

Teradata DSNのオプションの「HTTPS_PORT=<整数>」オプションを参照してください。

*IGNORESEARCHPATTERN=[Y | N]

または

*IGNORESEARCHPAT=[Y | N]

デフォルト = No

Teradata DSNのオプションの“IgnoreODBCSearchPattern=[Yes | No]”オプションを参照してください。

*LOGINTIMEOUT=<Time out Value> デフォルト = 20

Teradata DSNのオプションを参照してください。

*MAXRESPSIZE=<Resp Buffer size> デフォルト = 65536 (64K)

Teradata DSNのオプションを参照してください。

*MECHANISMKEY=<Value>

または

*AUTHENTICATIONPARAMETER=<Value>

Value=string

認証メカニズムに渡すパラメータとして認識される、ドライバからは隠された文字列です。認証メカニズムを設定するために呼び出されるTeradata認証ソフトウェアに渡されます。

このパラメータの構成手順については、Teradata DSNのオプションのMechanismKey=<Value>に関する説明を参照してください。

詳細については、<UTF16用のTDGSSのサポート>を参照してください。

$tdwallet()トークンを指定すると、このキーワードの値(または、この値の一部)としてTeradata Wallet参照文字列を使用できます。以下に例を示します。

AUTHENTICATIONPARAMETER=$tdwallet(WalletRefString);

詳細については、<Teradata Wallet>を参照してください。

*MECHANISMNAME=<MechanismName>

または

*AUTHENTICATION=<MechanismName>

データベース接続に使用する認証メカニズムを指定します。

デフォルトは、TeraGSSプログラムtdgssconfigureを実行してXMLファイルに設定された構成オプションに従って決定されます。

認証メカニズムの構成手順については、Teradata DSNのオプションのMechanismName=<MechanismName>に関する説明を参照してください。

詳細については、<認証メカニズム>を参照してください。

*MSACCESSINTEROPMODE=[Y | N]

または

*USEDATEDATAFORTIMESTAMPPARAMS=[Y | N]

デフォルト = No

(Windowsの場合のみ)

*NOSCAN=[Y | N] デフォルト = No

Teradata DSNのオプションの“NoScan=[Yes | No]”オプションを参照してください。

*NTERRLOG=[Y | N] デフォルト = No

(Windowsのみ)Yesを選択した場合、ユーザーは、ODBC Driver for Teradataから返されたエラーをイベント ログに記録できます。

Noを選択すると、イベント ログにエラーは記録されません。

*PASSWORD=<value>

または

*PWD=<value>

データ ソース仕様セクションの“Password=<パスワード>”オプションを参照してください。

$tdwallet()トークンを指定すると、このキーワードの値(または、この値の一部)としてTeradata Wallet参照文字列を使用できます。以下に例を示します。

PWD=$tdwallet(WalletRefString);

詳細については、<Teradata Wallet>を参照してください。

*PRINTOPTION= [P | N] デフォルト = No

Teradata DSNのオプションの“PrintOption=[O | P]”オプションを参照してください。

*PWD2=<value> Teradataサーバーにログオンするときにデフォルト ユーザー名で使用する副次パスワード(データ ソース仕様セクションのオプションを参照)。

SQLDriverConnectまたはSQLBrowseConnectが呼び出され、PWDが失効していた場合、ConnectStringInputとして認識される接続キーワードは、"PWD2=新規パスワード値"によって展開されます。

データベース セッションの確立を試行すると、ログオン リクエストがPWDを使用して発行されます。パスワードが失効したために制限ログオンが返される場合、MODIFYはPWD2を使用して発行されます。それからConnectStringOutputが更新されて、セッションを確立するために使用されるパスワードが反映されます。アプリケーションは、ログインで使用されるパスワードを検証し、そのパスワードを自身のログイン プロセスで使用します。
  • PWD2はConnectStringInput文字列をサポートしないため、パスワード失効によるエラーは、SQLConnect呼び出し時に返されます。
  • 通常は接続情報をキャッシュするアプリケーションでは、PWD2が動作しない可能性があります。
  • レジストリーに格納されているパスワードに対して、PWD2は動作しません。
PWD2が動作するためには、アプリケーション側で、パスワードの期限切れを処理する方法をデータベース セッションの接続プロセスが認識して、接続リクエストを送信するときにその情報を使用する必要があります。市販のODBCアプリケーションやサード パーティ製ツールでは、PWD2を使用できません。これは、接続コードで副次パスワードの使用方法を認識しないからです。PWD2が動作するのは、PWD2を使用するようにカスタマイズされているアプリケーションだけです。
*RECONNECTCOUNT=<value> デフォルト値は20です。

ドライバがデータベースへの再接続を試行する最大回数(0~99)。

*RECONNECTINTERVAL=<value> デフォルト値は30です。

再接続の試行間隔の秒数(1~300)。

*RETRYONEINTR=[Y | N] デフォルト = Y

このオプションでは、ODBC Driver for TeradataがEINTRでソケット システム呼び出しを再試行するかSQL_ERRORを返すかを制御できます。

以下のソケット システム呼び出しが対象となります。
  • connect()
  • select()
  • recv()
  • send()

Teradata DSNのオプションの“RETRYONEINTR=[Y | N]”オプションを参照してください。

*RETURNGENERATEDKEYS=<値> デフォルト = N

Teradata DSNのオプションのRETURNGENERATEDKEYS=<値>に関する説明を参照してください。

*SESSIONMODE=[ANSI|Teradata] デフォルト値は、CREATEまたはMODIFY USER文で使用されるオプションに基づいてデータベースによって決定されます。

Teradata DSNのオプションの“SessionMode=[TeradataANSI]”オプションを参照してください。Windows構成の場合は、Teradata ODBC Driver Options(Teradata ODBCドライバ オプション)Session Mode(セッション モード)メニューに関する説明を参照してください。

*SESSIONS=<value> デフォルト値はありません

Teradata DSNのオプションの"Sessions=<値>"オプションを参照してください。

*SPLOPTION=[Y | N] デフォルト = No

Teradata DSNのオプションの“SplOption=[Y | N]”オプションを参照してください。

SSLCA=<path> SSL CAパス

このオプションは、信頼済みCAのルート証明書が置かれているディレクトリのフルパスを指定します。SSLModeがVerify-CAまたはVerify-Fullに設定されていない場合、SSL CAファイル名またはSSL CAパスは無視されます。

SSLCAPath=<path> SSL CAファイル名

オペレーティング環境でのデフォルト設定がデフォルト値になります。

このオプションでは、信頼済みのルートCAおよび中間CAの1つまたは複数の証明書が入っている.pemファイルのフルパスと名前を指定します。SSLModeがVerify-CAまたはVerify-Fullに設定されていない場合、SSL CAファイル名またはSSL CAパスは無視されます。

このオプションを使用するには、「c_rehash」ツールを使用し、OpenSSLで使用される証明書ファイルのシンボリック リンクを作成する。

詳細については、OpenSSLのドキュメントを参照: https://www.openssl.org/docs/man1.1.1/man1/c_rehash.html

SSLMode=[Allow|Disable|Prefer|Require|Verify-CA|Verify-Full] デフォルト = 「Prefer(優先)」

ODBC Driver for Teradataが動作するTLSモードを指定します。

有効な値は、次のとおりです。

Prefer(優先)

ドライバはHTTPSポートとの接続を優先します。

その接続が失敗した場合に、ドライバはフォールバックしてTDMSTポートに接続します。

TLS証明書が正しく設定された状態でTeradata Gateway TLS設定が「有効」に設定されている場合、ODBC Driver for TeradataはHTTPSポートを使用した接続のみを試行し、接続に失敗すると対応するエラー メッセージが返される。

詳細については、Prefer/AllowのSSLModeでの確定的動作を参照。

Allow(許容)

ドライバはTDMSTポートとの接続を優先します。

その接続が失敗した場合に、ドライバはフォールバックしてHTTPSポートに接続します。

TLS証明書が正しく設定された状態でTeradata Gateway TLS設定が「有効」に設定されている場合、ODBC Driver for TeradataはTDMSTポートを使用した接続のみを試行し、接続に失敗すると対応するエラー メッセージが返される。

詳細については、Prefer/AllowのSSLModeでの確定的動作を参照。

Disable(無効)

ドライバはTDMSTポートでのみ接続します。

Require(必須)

ドライバはHTTPSポートでのみ接続します。

Verify-CA

"Require(必須)"モードに加えて、構成されているCA証明書に対するサーバー認証局(CA)証明書の検証が行なわれます。

Verify-Full

"Verify-CA(検証-CA)"モードに加えて、ホスト名識別検証が行なわれます。

SSLProtocol=[TLSv1.2] SSLプロトコル

現在サポートされているのはTLSv1.2のみです。

*TABLEQUALIFIER=[Y | N] デフォルト = No

このオプションをYesに設定すると、Catalog API関数のTable QualifierパラメータにNULL値が渡されます。

このオプションをNoに設定すると、Catalog API関数のTable QualifierパラメータにNULL値が渡されません。

*TCPNODELAY=[Y | N] デフォルト = Yes

Teradata DSNのオプションの“TCPNoDelay=[Yes | No]”オプションを参照してください。

*TDMSTPORTNUMBER=<port number> デフォルト = 1025

Teradata DSNのオプションの“TDMSTPortNumber=<整数>”オプションを参照してください。

*TYPE=[Default|FastExport] デフォルト = "Default"

Teradata DSNのオプションの"Type=[Default|FastExport]"オプションを参照してください。

*USECOLUMNNAMES=[Y | N]

または

*DONTUSETITLES=[Y | N]

デフォルト = Yes

Teradata DSNのオプションの“DontUseTitles=[Yes | No]”オプションを参照してください。

USEDATAENCRYPTION=[Y |N]

または

DATAENCRYPTION=[Y |N]

デフォルト = No

DataEncryptionがYesである場合、ODBC Driver for Teradataはデータを暗号化するので、Teradata GatewayとODBC Driver for Teradataは暗号化された方式で相互に通信します。

DATAENCRYPTIONがNoの場合、ODBC Driver for Teradataは、ログオン情報以外のデータは暗号化しません。

USEREGIONALSETTINGS=[Y | N]

または

REGIONALDECIMALSYMBOL=[Y | N]

デフォルト = Yes

[WindowsおよびApple macOS]Teradata ODBC Driver Options(Teradata ODBCドライバ オプション)の“Use Regional Settings for Decimal Symbol(10進記号の地域設定を使用する)”オプションを参照してください。

*USERNAME=<value>

または

*UID=<value>

データ ソース仕様セクションの“Username=<名前>”オプションを参照してください。
*USEXVIEWS=[Y | N] デフォルト = No

Teradata DSNのオプションの“UseXViews=[Yes|No]”オプションを参照してください。