データベース接続文字列の作成 (Create Database Connection String) (データ管理)

サマリー

ジオプロセシング ツールがデータベースまたはエンタープライズ ジオデータベースへの接続に使用できる接続文字列を作成します。

使用法

  • データベースまたはエンタープライズ ジオデータベースのデータセットを使用する自動化されたジオプロセシング ワークフロー (スクリプトまたはモデル) がある場合、接続ファイルの代わりにこのツールを使用します。 接続ファイルのワークスペースを介してデータベースのパスを使用するのではなく、指定したデータセット タイプをサポートする任意のジオプロセシング ツールの入力として使用できる接続文字列を生成できます。

  • ArcGIS から Altibase および Netezza への接続は、サポートされなくなりました。

パラメーター

ラベル説明データ タイプ
データベース プラットフォーム

接続先のデータベース プラットフォームを指定します。

  • SQL ServerMicrosoft SQL Server または Microsoft Azure SQL データベースに接続します。
  • OracleOracle に接続します。
  • Db2IBM DB2 (Linux、UNIX、Windows) に接続します。
  • PostgreSQLPostgreSQL に接続します。
  • TeradataTeradata データ ウェアハウス アプライアンスに接続します。
  • SAP HANASAP HANA に接続します。
  • DamengDameng に接続します。
String
インスタンス

接続先のデータベース サーバーまたはインスタンス。

このパラメーター値は、選択された [データベース プラットフォーム] パラメーターの値によって異なります。

String
データベース認証
(オプション)

使用される認証のタイプを指定します。

  • データベース認証データベース認証が使用されます。 内部データベース ユーザー名およびパスワードが、データベースへの接続に使用されます。 コネクションを作成するときにユーザー名とパスワードを入力する必要はありませんが、入力していない場合は、コネクションが確立されたときにユーザー名とパスワードを入力するよう求められます。 これがデフォルトです。
    注意:

    作成する接続ファイルによって、ArcGIS サービスにデータベースまたはジオデータベースへのアクセス権限が付与される場合、またはカタログ検索を使用してこの接続ファイル経由でアクセスするデータを検索する場合は、ユーザー名およびパスワードを入力する必要があります。

  • オペレーティング システム認証オペレーティング システム認証が使用されます。 ユーザー名とパスワードを入力する必要はありません。 オペレーティング システムへのログインで使用されたユーザー名とパスワードを使ってコネクションが作成されます。 オペレーティング システムで使用したログイン情報がジオデータベースへのログインで無効な場合、コネクションは確立されません。
Boolean
Username
(オプション)

データベース認証で使用されるデータベース ユーザー名。

String
パスワード
(オプション)

データベース認証で使用されるデータベース ユーザー パスワード。

Encrypted String
データベース
(オプション)

接続先のデータベースの名前。 このパラメーターは、PostgreSQL および SQL Server プラットフォームにのみ適用されます。

String
データセット オブジェクト名
(オプション)

接続文字列が指すデータベース内のデータセットまたはオブジェクトの名前。 この接続文字列は、指定したデータセットのパスとして使用できます。

String
データ タイプ
(オプション)

データセット オブジェクト名で参照されるデータセットまたはオブジェクトのタイプ。 データベース内に同じ名前を持つ複数のオブジェクトが存在する場合、接続文字列を作成するオブジェクトのデータ タイプの指定が必要になることがあります。

String
ターゲット フィーチャ データセット
(オプション)

接続文字列を作成するデータセットまたはオブジェクトを含んでいるフィーチャ データセットの名前。 データセットがフィーチャ データセットに含まれていない場合 (たとえば、データベースのルートにある場合) は、ターゲット フィーチャ データセットを指定しないでください。

String
スキーマ (Oracle ユーザー スキーマ ジオデータベースのみ)
(オプション)

接続先のユーザー スキーマ ジオデータベース。 ツールは、接続先がユーザー スキーマ ジオデータベースがある Oracle データベースかどうかを判定します。 Oracle データベースにユーザー スキーマがある場合、このオプションは有効になり、ない場合は無効のままになります。 このパラメーターのデフォルト オプションは、sde スキーマ (マスター) ジオデータベースの使用です。

String
バージョン タイプ
(オプション)

接続先のバージョンのタイプを指定します。 このパラメーターは、ジオデータベースに接続する場合にのみ適用されます。

注意:

[履歴] が選択され、名前が入力されていない場合、デフォルトのトランザクション バージョンが使用されます。 [時点] が選択され、[日時] パラメーターに日付が入力されていない場合、デフォルトのトランザクション バージョンが使用されます。

  • トランザクショントランザクション バージョンに接続します。 [トランザクション] が選択された場合、[次のバージョンを使用する] パラメーターがトランザクション バージョンのリストを使用して入力され、[日時] パラメーターが無効になります。 これがデフォルトです。
  • 履歴履歴マーカーに接続します。 [履歴] が選択された場合、[次のバージョンを使用する] パラメーターが履歴マーカーのリストを使用して入力され、[日時] パラメーターが無効になります。
  • 時点特定時点に接続します。 [時点] が選択された場合、[次のバージョンを使用する] パラメーターが無効になり、[日時] パラメーターが有効になります。
  • ブランチデフォルトのブランチ バージョンに接続します。
String
次のバージョンが使用されます
(オプション)

接続するジオデータベースのトランザクション バージョンまたは履歴マーカー。 デフォルト オプションは、デフォルトのトランザクション バージョンを使用します。

ブランチ バージョン タイプを選択すると、デフォルトのブランチ バージョンに常に接続します。

String
日時
(オプション)

データベース接続に使用する日時を表す値。 このパラメーターは、履歴管理が有効なデータとともに使用されます。 適切な日付を選択するには、時刻ピッカーを使用します。

日付を手動で入力する場合は、次の形式が使用できます。

  • 6/9/2011 4:20:15 PM
  • 6/9/2011 16:20:15
  • 6/9/2011
  • 4:20:15 PM
  • 4:20:15 PM

注意:

  • 日付を入力しないまま時刻を入力すると、デフォルトの日付である December 30、1899 が使用されます。
  • 時刻を入力しないまま日付を入力すると、デフォルトの時刻である 12:00:00 AM が使用されます。

Date

派生した出力

ラベル説明データ タイプ
CIMDATA 接続文字列

CIMDATA 接続文字列。

String

arcpy.management.CreateDatabaseConnectionString(database_platform, instance, {account_authentication}, {username}, {password}, {database}, {object_name}, {data_type}, {feature_dataset}, {schema}, {version_type}, {version}, {date})
名前説明データ タイプ
database_platform

接続先のデータベース プラットフォームを指定します。

  • SQL_SERVERMicrosoft SQL Server または Microsoft Azure SQL データベースに接続します。
  • ORACLEOracle に接続します。
  • DB2IBM DB2 (Linux、UNIX、Windows) に接続します。
  • POSTGRESQLPostgreSQL に接続します。
  • TERADATATeradata データ ウェアハウス アプライアンスに接続します。
  • SAP HANASAP HANA に接続します。
  • DAMENGDameng に接続します。
String
instance

接続先のデータベース サーバーまたはインスタンス。

このパラメーター値は、選択された [データベース プラットフォーム] パラメーターの値によって異なります。

String
account_authentication
(オプション)

使用される認証のタイプを指定します。

  • DATABASE_AUTHデータベース認証が使用されます。 内部データベース ユーザー名およびパスワードが、データベースへの接続に使用されます。 コネクションを作成するときにユーザー名とパスワードを入力する必要はありませんが、入力していない場合は、コネクションが確立されたときにユーザー名とパスワードを入力するよう求められます。 これがデフォルトです。
    注意:

    作成する接続ファイルによって、ArcGIS サービスにデータベースまたはジオデータベースへのアクセス権限が付与される場合、またはカタログ検索を使用してこの接続ファイル経由でアクセスするデータを検索する場合は、ユーザー名およびパスワードを入力する必要があります。

  • OPERATING_SYSTEM_AUTHオペレーティング システム認証が使用されます。 ユーザー名とパスワードを入力する必要はありません。 オペレーティング システムへのログインで使用されたユーザー名とパスワードを使ってコネクションが作成されます。 オペレーティング システムで使用したログイン情報がジオデータベースへのログインで無効な場合、コネクションは確立されません。
Boolean
username
(オプション)

データベース認証で使用されるデータベース ユーザー名。

String
password
(オプション)

データベース認証で使用されるデータベース ユーザー パスワード。

Encrypted String
database
(オプション)

接続先のデータベースの名前。 このパラメーターは、PostgreSQL および SQL Server プラットフォームにのみ適用されます。

String
object_name
(オプション)

接続文字列が指すデータベース内のデータセットまたはオブジェクトの名前。 この接続文字列は、指定したデータセットのパスとして使用できます。

String
data_type
(オプション)

データセット オブジェクト名で参照されるデータセットまたはオブジェクトのタイプ。 データベース内に同じ名前を持つ複数のオブジェクトが存在する場合、接続文字列を作成するオブジェクトのデータ タイプの指定が必要になることがあります。

String
feature_dataset
(オプション)

接続文字列を作成するデータセットまたはオブジェクトを含んでいるフィーチャ データセットの名前。 データセットがフィーチャ データセットに含まれていない場合 (たとえば、データベースのルートにある場合) は、ターゲット フィーチャ データセットを指定しないでください。

String
schema
(オプション)

接続先のユーザー スキーマ ジオデータベース。 このオプションは、ユーザー スキーマ ジオデータベースのある Oracle データベースにのみ適用されます。 このパラメーターのデフォルト値は、sde スキーマ (マスター) ジオデータベースの使用です。

String
version_type
(オプション)

接続先のバージョンのタイプを指定します。 このパラメーターは、ジオデータベースに接続する場合にのみ適用されます。

  • TRANSACTIONALトランザクション バージョンに接続します。 [トランザクション] が選択された場合、[次のバージョンを使用する] パラメーターがトランザクション バージョンのリストを使用して入力され、[日時] パラメーターが無効になります。 これがデフォルトです。
  • HISTORICAL履歴マーカーに接続します。 [履歴] が選択された場合、[次のバージョンを使用する] パラメーターが履歴マーカーのリストを使用して入力され、[日時] パラメーターが無効になります。
  • POINT_IN_TIME特定時点に接続します。 [時点] が選択された場合、[次のバージョンを使用する] パラメーターが無効になり、[日時] パラメーターが有効になります。
  • BRANCHデフォルトのブランチ バージョンに接続します。

注意:

[履歴] が選択され、名前が入力されていない場合、デフォルトのトランザクション バージョンが使用されます。 [時点] が選択され、[日時] パラメーターに日付が入力されていない場合、デフォルトのトランザクション バージョンが使用されます。

String
version
(オプション)

接続するジオデータベースのトランザクション バージョンまたは履歴マーカー。 デフォルト オプションは、デフォルトのトランザクション バージョンを使用します。

ブランチ バージョン タイプを選択すると、デフォルトのブランチ バージョンに常に接続します。

String
date
(オプション)

履歴管理が有効なデータを操作するときに、データベース接続に使用する日時を表す値。

日付は、次の形式で入力できます。

  • 6/9/2011 4:20:15 PM
  • 6/9/2011 16:20:15
  • 6/9/2011
  • 4:20:15 PM
  • 4:20:15 PM

注意:

  • 日付を入力しないまま時刻を入力すると、デフォルトの日付である December 30、1899 が使用されます。
  • 時刻を入力しないまま日付を入力すると、デフォルトの時刻である 12:00:00 AM が使用されます。

Date

派生した出力

名前説明データ タイプ
out_connection_string

CIMDATA 接続文字列。

String

コードのサンプル

CreateDatabaseConnectionString (データベース接続文字列の作成) の例 (Python ウィンドウ)

次の Python ウィンドウ スクリプトは、イミディエイト モードで CreateDatabaseConnectionString 関数を使用する方法を示しています。

import arcpy
data_conn_str = arcpy.CreateDatabaseConnectionString_management("SQL_SERVER",
                                          "utah",
                                          "DATABASE_AUTH",
                                          "gdb",
                                          "gdb", 
                                          "",
                                          "gdb.roads")
arcpy.Buffer_analysis(data_conn_str, r"c:\temp\Buffers.shp", "10 Miles")

環境

特殊なケース

ライセンス情報

  • Basic: Yes
  • Standard: Yes
  • Advanced: Yes

関連トピック