AlteryxService MongoDB スキーマ
AlteryxService MongoDBは、Serverインスタンスのサービスレイヤーデータベースです。この資料では、Serverバージョン2023.2に対応するAlteryxService MongoDBスキーマバージョン46について説明します。埋め込みMongoDBまたはユーザー管理MongoDBのいずれかを使用するServerは、このスキーマを使用します。
Serverの管理者は、レポートと分析を行うために、ServerインスタンスのMongoDBスキーマへのアクセスが必要になる場合があります。MongoDBスキーマには、互換性のあるクライアントなら、どれを使用してもアクセスできます。mongo Shell は、コマンドラインからのアクセスに適したツールです。MongoDB Compass は、GUIからのアクセスに適したツールです。MongoDB Atlas を使用している場合は、Atlas Webコンソールからデータベースドキュメントにアクセスできます。
警告
MongoDBデータベースを直接編集することはできません。直接編集すると、予期しない結果が生じる可能性があります。
AlteryxService MongoDBは、以下のコレクションで構成されています。コレクションは、MongoDBドキュメントのグループで、フィールドと値のペアの集合です。コレクションを選択すると、フィールドの定義(スキーマと呼ばれる)が表示されます。
[Collection].Filesコレクションは、ドキュメントがMongoDBの最大ドキュメントサイズである16MBを超える場合に使用されます。「MongoDBドキュメントの制限」を参照してください。
AS_App_Chunksコレクションには、ワークフローパッケージチャンクが格納されています。ドキュメントがMongoDBの最大ドキュメントサイズを超える場合は、対応するAS_App_Chunks.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
Checksum: (文字列)チャンク内容のSHA256チェックサム。
Chunk: (バイナリ)チャンクの内容。
RequestID: (文字列)このアプリチャンクをアップロードしたフロントエンドのRequestID。
AS_ApplicationVersionsコレクションには、ワークフローのバージョン履歴が格納されています。ドキュメントがMongoDBの最大ドキュメントサイズを超えた場合は、対応するAS _ApplicationVersions.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
ApplicationId: (文字列)ワークフローID (AS_Applicationsテーブルにあるもの)。
VersionHistory: (文字列)パイプで区切られたバージョンのリスト。
AS_Applicationsコレクションには、サービスデータベースに保存されているワークフローに関するデータが格納されています。ドキュメントがMongoDBの最大ドキュメントサイズを超えた場合は、対応するAS_Applications.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
UserName: (文字列) スケジュールに関連付けられたユーザーのユーザー名または (AlteryxGallery.users コレクションでの) MongoDB ユーザー ID 。
CPUName: (文字列)スケジュールを作成したワークステーションまたはServerノードのホスト名またはIPアドレス。
CreationDateTime: (日時)レコードが作成された日時(ローカルサーバー時間)。
ModuleName: (文字列)ワークフローのファイル名。
InternalFileName: (文字列)ファイル名。
PackageDefinition: (文字列)関連付けられているパッケージ定義のID。
Module: (バイナリ)ワークフロー(その全体が格納されている場合)。
RequestID: (文字列)このアプリケーションをアップロードしたフロントエンドのRequestID。
AS_Galleries コレクションには、Server UI 登録に関するサービス層情報が格納されています (将来使用できるようにするため)。ドキュメントがMongoDBの最大ドキュメントサイズを超えた場合は、対応するAS_Galleries.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
HostName: (文字列) Server UIノードのURI。
GalleryId: (文字列) ServerHostの特定のライフサイクルにおけるServer UIノードの一意のID。
LastUpdateDateTime: (日時) Server UI登録が最後に更新された日時。
AS_Insightsコレクションには、サービスデータベースに保存されているワークフローに関するデータが格納されています。ドキュメントがMongoDBの最大ドキュメントサイズを超えた場合は、対応するAS_Insights.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
UserName: (文字列) インサイトに関連付けられているユーザーのユーザー名または (AlteryxGallery.users コレクションでの) MongoDB ユーザー ID。
CreationDateTime: (日時)レコードが作成された日時(ローカルサーバー時間)。
InsightId: (文字列)このインサイトの有効なプライマリキー。
Insight: (バイナリ)インサイトファイル。
AS_PackageDefinitionsコレクションには、パッケージ定義データが格納されています。ドキュメントがMongoDBの最大ドキュメントサイズを超える場合は、対応するAS_PackageDefinitions.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
UserName: (文字列) スケジュールに関連付けられたユーザーのユーザー名または (AlteryxGallery.users コレクションでの) MongoDB ユーザー ID 。
CPUName: (文字列)スケジュールを作成したワークステーションまたはServerノードのホスト名またはIPアドレス。
CreationDateTime: (日時)レコードが作成された日時(ローカルサーバー時間)。
PackageDefinition: (文字列)パッケージ定義XML。
AS_Queueコレクションには、キューに入れられたジョブが格納されています。現在待機中のジョブと完了したジョブの両方がキューに存在します。ドキュメントがMongoDBの最大ドキュメントサイズを超えた場合は、対応するAS_Queue.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
__Priority: (Int64)キューのソートに使用される長いInt32。
AS_Application_ID: (文字列) AS_Applications のワークフロー ID。
Type: (文字列)ジョブのタイプ。
UserName: (文字列)ジョブに関連付けられているユーザーのユーザー名または(AlteryxGallery.usersコレクションでの) MongoDBユーザーID。
SubscriptionId: (文字列): サブスクリプションID。
CreationDateTime: (日時)ジョブが作成された日時(ローカルサーバー時間)。
Status: (文字列)ジョブのステータス。
Owner: (文字列)キューからジョブを取得したワーカーのホスト名とワーカーID。
CompletionDateTime: (日時)ジョブが完了した日時(ローカルサーバー時間)。
QOS_Priority: (Int64)ジョブの優先順位。
IsAnonymous: (ブール値)匿名ユーザーがキューに入れたジョブのフラグ。
IsHidden: (ブール値)アプリが一連の連鎖アプリの最後のアプリではない場合、True。
RestrictOutput: (ブール値)。廃止。パブリックGalleryからの残留物。
AppName: (文字列)ワークフロー名。
ClientType: (文字列)ジョブを作成したクライアントのタイプ。
AS_Schedules_ID: (文字列)キューレコードに関連付けられたスケジュールのID。
AlteryxResultCode: (Int32)ワークフローを実行するEngineからの結果コード。
DefaultModule: (文字列)実行されるワークフローの名前。具体的には、複数のワークフローファイルを含むパッケージで既定で実行されるワークフローの名前です。
Error: (文字列)実行が失敗したジョブのエラーメッセージ。
ExecutionTime: (Double)ジョブのランタイム。
JobName: (文字列)スケジュールされたジョブの場合、スケジュールの名前。それ以外の場合は、ユーザーがジョブに付けた名前(あれば)。
ModuleName: (文字列)実行されるワークフローの名前。DefaultModuleとは異なる場合があります。
Parameters: (文字列) Engineに渡すパラメーター。
QueueInputIDs: (文字列)ジョブで使用される(AS_QueueInputsテーブルにある)キュー入力IDのパイプで区切られたコレクション。
RequestID: (文字列)ジョブの実行をトリガーしたフロントエンドのRequestID。
ResultIDs: (文字列)このジョブで使用される、以前のジョブによって生成された(AS_ResultsFilesテーブルにある)結果IDのパイプで区切られたコレクション。
RunAsPasswordId: (文字列)このジョブで使用される(AS_RunAsCredentialsテーブルにある) RunAsパスワードのID。
RunAsUser: (文字列)このジョブで使用されるRunAsアカウントのユーザー名。
RunWithE2: (ブール値)このジョブをE2で明示的に実行するか否か。
Version: (文字列)アプリに複数のバージョンがある場合に使用するアプリパッケージのバージョン。
WizardValues: (文字列)分析アプリの質問に対する回答。
WorkerTag: (文字列)このジョブのワーカータグ。
AS_QueueInputs には、アプリの実行時に使用される一時入力ファイルが格納されています。例えば、File Browse ツールで選択された入力です。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
UserName: (文字列) スケジュールに関連付けられたユーザーのユーザー名または (AlteryxGallery.users コレクションでの) MongoDB ユーザー ID 。
CreationDateTime: (日時)ユーザーがファイルをアップロードした日時。
FileName: (文字列) ファイル名。
InternalFileName: (文字列)ファイル名。
File: (バイナリ)ファイルのバイナリ。
RequestID: (文字列)このキュー入力ファイルをアップロードしたフロントエンドのRequestID。
AS_ResourcePermissionsコレクションには、データ接続の権限コンテキストに関するデータが格納されています。ドキュメントがMongoDBの最大ドキュメントサイズを超えた場合は、対応するAS_ResourcePermissions.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
ResourceId: (文字列) リソース ID。
ContextId: (文字列) 権限コンテキスト ID。
AS_Resourcesコレクションには、データ接続に関する情報が格納されています。ドキュメントがMongoDBの最大ドキュメントサイズを超えた場合は、対応するAS_Resources.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
ResourceId: (文字列) リソース ID。
ResourceValue: (文字列)リソース値。
AS_Resultsコレクションには、ワークフローの結果データが格納されています。ドキュメントがMongoDBの最大ドキュメントサイズを超えた場合は、対応するAS_Results.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
AS_Queue_ID: (文字列)この結果を生成したジョブのID。
UserName: (文字列) スケジュールに関連付けられたユーザーのユーザー名または (AlteryxGallery.users コレクションでの) MongoDB ユーザー ID 。
OutputLog: (バイナリ)ワークフローを記述している間にEngineが書いたメッセージ。バイナリ形式で格納されます。
TotalFileSize: (Int64)このジョブ結果のAS_ResultsFiles内のすべてのファイルの累積サイズ(バイト単位)。
ExecutionStartTime: (日時)ワークフローの実行が開始された日時。
ExecutionTime: (Double)ワークフローの実行にかかった時間。
AS_ResultsFilesコレクションには、ワークフローの結果データが格納されています。ドキュメントがMongoDBの最大ドキュメントサイズを超えた場合は、対応するAS_ResultsFiles.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
AS_Queue_ID: (文字列)この結果ファイルを生成したジョブのID。
UserName: (文字列) スケジュールに関連付けられたユーザーのユーザー名または (AlteryxGallery.users コレクションでの) MongoDB ユーザー ID 。
FileName: (文字列) ファイル名。
File: (バイナリ)ファイルの内容。
AS_RunAsCredentialsにはRun As資格情報が格納されています。ドキュメントがMongoDBの最大ドキュメントサイズを超えた場合は、対応するAS_RunAsCredentials.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
EncData: (文字列)暗号化されたRunAsパスワード。
AS_Schedulesには、スケジュールに関するサービスレイヤー情報が格納されています。ドキュメントがMongoDBの最大ドキュメントサイズを超える場合は、対応するAS_Schedules.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
AS_Application_ID: (文字列) AS_ApplicationsからのワークフローID。
UserName: (文字列) スケジュールに関連付けられたユーザーのユーザー名または (AlteryxGallery.users コレクションでの) MongoDB ユーザー ID 。
CPUName: (文字列)スケジュールを作成したワークステーションまたはServerノードのホスト名またはIPアドレス。
CreationDateTime: (日時)スケジュールが作成された日時(ローカルサーバー時間)。
NextRunDateTime: (日時)スケジュールが次に実行される日時(ローカルサーバー時間)。
UntilDateTime: (日時)スケジュールの終了日時(ローカルサーバー時間)。
LastRunDateTime: (日時)スケジュールが最後に実行された日時(ローカルサーバー時間)。
Status: (文字列) スケジュールのステータス。
LC_ScheduleName: (文字列)スケジュールの名前(小文字)。
LC_Owner: (文字列)スケジュールの所有者(小文字)。
ClientType: (文字列) 作成されたスケジュールのタイプ。
AS_PackageDefinition__ID: (文字列) パッケージ定義 ID。
ApplicationName: (文字列)スケジュールされたワークフローの名前。
AS_Queue_ID: (文字列)スケジュールに対して直近で実行されたジョブのID。
Comment: (文字列)スケジュールのコメント。
CredentialId: (文字列)スケジュールに関連付けられている資格情報。
CredentialSource: (文字列)スケジュールの資格情報の取得元。
Enabled: (ブール値)スケジュールの実行が有効か否か。
Frequency: (文字列)スケジュールが読み取り可能な形式で実行される頻度。
Iteration: (文字列)スケジュールのシリアル化されたイテレーション。
IterationFormula: (文字列)スケジュールフォーミュラのシリアル化されたイテレーション。
LastErrorCode: (文字列)スケジュールの最後のエラーコード。
LastModifiedDate: (日時)スケジュールが最後に変更された日付。
LastModifiedId: (文字列)スケジュールを最後に変更したユーザー。
NumberOfTimesRun: (Int64)スケジュールが実行された回数。
Type: (文字列)
Owner: (文字列)スケジュールの所有者。
PasswordId:(文字列)資格情報パスワードのID。
Priority: (Int64)スケジュールの優先順位。
RequestId: (文字列)このスケジュールを作成したフロントエンドのRequestID。
RunAsUser (文字列)スケジュールジョブを実行するユーザーのコンテキスト。
RunWithE2: (ブール値)スケジュールがAMPワークフローのためのものであるか否か。
ScheduleName: (文字列)スケジュールの名前。
StartDateTime: (日時)ワークフローの実行を開始する日時。
Timezone: (文字列)スケジュールのタイムゾーン。
WorkerTag: (文字列)スケジュールのワーカータグ
AS_TileSetAccessTimes コレクションは現在、使用されていません。
AS_TileSetsコレクションには、サービスデータベースに保存されているワークフローに関するデータが格納されています。ドキュメントがMongoDBの最大ドキュメントサイズを超えた場合は、対応するAS _TileSets.Filesコレクションが使用されます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
__Version: (Int32) バージョン番号。
Checksum: (文字列)タイルセットのSHA256チェックサム。
TileSetPool: (文字列)プールID。
RenderSettings: (文字列)レンダリング設定。
YxdbInfo: (バイナリ) YXDBファイルのメタ情報。
AS_Versionsコレクションは、移行用のテーブルおよびコレクションのバージョンデータを含み、暗号移行が不要になったことを示すマーカーとして機能します。AS_Versionコレクションが存在しない場合は、必要でない場合でもシステムが暗号移行を実行します。
注記
AS_Versionsコレクションはスキーマバージョンには関連していません。
_id: (オブジェクトID)ドキュメントのプライマリキー。
id: (文字列)
tableName: (文字列)テーブルの名前。
versionNumber: (Int32)バージョン番号。このversionNumberはスキーマバージョンには関連していません。
completionDate: (文字列)ジョブが完了した日付。
versionsコレクションには、MongoDB AlteryxServiceデータベーススキーマのバージョンデータが含まれます。
_id: (オブジェクトID)ドキュメントのプライマリキー。
Number: (Int32) AlteryxServiceスキーマのバージョン番号。
MigrationDate: (文字列)スキーマ移行が実行された時刻のタイムスタンプ。