MongoDB Relational Migrator REST API
Reduce によるAPI Docs

MongoDB Relational Migrator REST API ( 1.11.0 )

OpenAPI 仕様をダウンロード: ダウンロード

URL： https://support.mongodb.com/help

MongoDB Relational Migrator ツールの OpenAPI 仕様

Codegen

プロジェクト マッピングに基づくコード生成

generateCode

プロジェクトのマッピングルールとスキーマ変換に基づいてアプリケーション コードを生成します

path パラメータ
projectId
必須
string （id） ^[A-Za-z0-9\-]+$

プロジェクトID

リクエスト ボディ スキーマ: application/json
collections
必須
の配列 string

生成されたコードに含める MongoDB コレクション

includeSupportFiles
必須
ブール値

サポート ファイルを含めるかどうか（選択した言語とフレームワークに該当する場合）

言語
必須
string （codegen-言語-type）
列挙: "Java" "CSMongoDB" "JavaSCRIPT" "JSON" "Python"
フレームワーク
必須
string (codegen-Framework-type)
列挙: "POJO" "POCO" "SPING_DATA" "PERSTENCY_LAYER" "MONGOSE_SCHEMAS" "NOde" "MONGODB_JSON_SCHEMA" "STANDARD_JSON_SCHEMA" "JSON_EXAMPLE_SCHEMA" "PYTH_TypeD_DECT_CLASSES"

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "collections": [
    ],
  • "includeSupportFiles": true,
  • "language": "JAVA",
  • "framework": "POJO"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "language": "JAVA",
  • "framework": "POJO",
  • "files": [
    ]
}

getCodegenMetadata

コード生成に使用可能な言語とフレームワークを取得します

path パラメータ
projectId
必須
string （id） ^[A-Za-z0-9\-]+$

プロジェクトID

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "metadata": [
    ]
}

ジョブ

データ移行

getJobs

すべての移行ジョブを取得する

クエリ パラメータ
sort
string^\w+,(DESC|ASC)$
デフォルト: "submittedAt,DESC"
例: sort=submittedAt,DESC

結果を検索する順序

limit
integer
例: limit=20

結果を制限する

タイプ
string (migration- jobs-get-type)
値: "IN_PROGESS"
例: type=IN_PROGESS

特定のジョブタイプのみにジョブをフィルタリング

projectId
string （id） ^[A-Za-z0-9\-]+$

projectId でジョブをフィルタリング

応答

応答サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

createJob

新しい移行ジョブを送信する

リクエスト ボディ スキーマ: application/json
projectId
必須
string
必須
オブジェクト (jdBC-接続-詳細)
必須
オブジェクト (mongodb-接続-詳細)
必須
オブジェクト （移行ジョブ記述子オプション）
必須
オブジェクト （移行検証）
オブジェクト （リレーショナルテーブル フィルター）

スキーマ

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "projectId": "string",
  • "jdbcConnectionDetails": {
    },
  • "mongodbConnectionDetails": {
    },
  • "options": {
    },
  • "verification": {
    },
  • "relationalTableFilters": {
    }
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "id": "string",
  • "projectId": "string",
  • "status": "RUNNING",
  • "cdcStatus": "NOT_STARTED",
  • "verificationJobId": "string",
  • "options": {
    },
  • "jdbcConnectionString": "string",
  • "mongoDbConnectionString": "string",
  • "atlasMetadata": {
    },
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "statistics": {
    },
  • "cdcStatistics": {
    },
  • "jobUpdates": [
    ],
  • "failureError": {
    },
  • "metadata": {
    },
  • "relationalTableFilters": {
    }
}

getJob

ID で移行ジョブのステータスを取得する

path パラメータ
jobId
必須
string （id） ^[A-Za-z0-9\-]+$

jobId

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "id": "string",
  • "projectId": "string",
  • "status": "RUNNING",
  • "cdcStatus": "NOT_STARTED",
  • "verificationJobId": "string",
  • "options": {
    },
  • "jdbcConnectionString": "string",
  • "mongoDbConnectionString": "string",
  • "atlasMetadata": {
    },
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "statistics": {
    },
  • "cdcStatistics": {
    },
  • "jobUpdates": [
    ],
  • "failureError": {
    },
  • "metadata": {
    },
  • "relationalTableFilters": {
    }
}

pauseJob

実行中の移行ジョブを一時停止する

path パラメータ
jobId
必須
string （id） ^[A-Za-z0-9\-]+$

jobId

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "id": "string",
  • "projectId": "string",
  • "status": "RUNNING",
  • "cdcStatus": "NOT_STARTED",
  • "verificationJobId": "string",
  • "options": {
    },
  • "jdbcConnectionString": "string",
  • "mongoDbConnectionString": "string",
  • "atlasMetadata": {
    },
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "statistics": {
    },
  • "cdcStatistics": {
    },
  • "jobUpdates": [
    ],
  • "failureError": {
    },
  • "metadata": {
    },
  • "relationalTableFilters": {
    }
}

resumeJob

一時停止した移行ジョブを再開する

path パラメータ
jobId
必須
string （id） ^[A-Za-z0-9\-]+$

jobId

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "id": "string",
  • "projectId": "string",
  • "status": "RUNNING",
  • "cdcStatus": "NOT_STARTED",
  • "verificationJobId": "string",
  • "options": {
    },
  • "jdbcConnectionString": "string",
  • "mongoDbConnectionString": "string",
  • "atlasMetadata": {
    },
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "statistics": {
    },
  • "cdcStatistics": {
    },
  • "jobUpdates": [
    ],
  • "failureError": {
    },
  • "metadata": {
    },
  • "relationalTableFilters": {
    }
}

stopJob

実行中の移行ジョブを停止する

path パラメータ
jobId
必須
string （id） ^[A-Za-z0-9\-]+$

jobId

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "id": "string",
  • "projectId": "string",
  • "status": "RUNNING",
  • "cdcStatus": "NOT_STARTED",
  • "verificationJobId": "string",
  • "options": {
    },
  • "jdbcConnectionString": "string",
  • "mongoDbConnectionString": "string",
  • "atlasMetadata": {
    },
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "statistics": {
    },
  • "cdcStatistics": {
    },
  • "jobUpdates": [
    ],
  • "failureError": {
    },
  • "metadata": {
    },
  • "relationalTableFilters": {
    }
}

プロジェクト

リレーショナルスキーマとマッピングを取得

getProjects

すべてのプロジェクトを取得する

クエリ パラメータ
sort
string^\w+,(DESC|ASC)$
デフォルト: "lastModified,DESC"
例: sort=lastModified,DESC

結果を検索する順序

応答

応答サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

クエリ

クエリ変換

getQuerys

プロジェクトに関連するすべてのクエリの概要を取得する

path パラメータ
projectId
必須
string （id） ^[A-Za-z0-9\-]+$

プロジェクトID

応答

応答サンプル

コンテンツタイプ
application/ JSON
[
  • {
    }
]

createQuery

新しいアドホック クエリを作成する

path パラメータ
projectId
必須
string （id） ^[A-Za-z0-9\-]+$

プロジェクトID

リクエスト ボディ スキーマ: application/json
inputQuery
string

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "inputQuery": "string"
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "id": "string",
  • "projectId": "string",
  • "input": {
    },
  • "output": {
    }
}

stopBulkQueryConversion

実行中中の一括クエリ変換ジョブを停止する

path パラメータ
projectId
必須
string （id） ^[A-Za-z0-9\-]+$

プロジェクトID

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "pendingQueries": [
    ],
  • "runningQueries": [
    ],
  • "completedQueries": [
    ],
  • "failedQueries": [
    ]
}

getBulkQueryConversion

一括クエリ変換ジョブのステータスを取得する

path パラメータ
projectId
必須
string （id） ^[A-Za-z0-9\-]+$

プロジェクトID

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "pendingQueries": [
    ],
  • "runningQueries": [
    ],
  • "completedQueries": [
    ],
  • "failedQueries": [
    ]
}

createBulkQueryConversion

一括クエリ変換ジョブの作成

path パラメータ
projectId
必須
string （id） ^[A-Za-z0-9\-]+$

プロジェクトID

リクエスト ボディ スキーマ: application/json
言語
必須
string (convert-query-言語タイプ)
列挙: "Java" "CSMongoDB" "JavaSCRIPT"
クエリ
必須
の配列 string
tryTypedEntity
ブール値

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "language": "JAVA",
  • "queries": [
    ],
  • "attemptTypedEntities": true
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "pendingQueries": [
    ],
  • "runningQueries": [
    ],
  • "completedQueries": [
    ],
  • "failedQueries": [
    ]
}

deleteQuery

ID でクエリを削除

path パラメータ
projectId
必須
string （id） ^[A-Za-z0-9\-]+$

プロジェクトID

queryId
必須
string （id） ^[A-Za-z0-9\-]+$

クエリ ID

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "jobId": "string",
  • "message": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

getQuery

ID でクエリを取得する

path パラメータ
projectId
必須
string （id） ^[A-Za-z0-9\-]+$

プロジェクトID

queryId
必須
string （id） ^[A-Za-z0-9\-]+$

クエリ ID

応答

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "query": {
    },
  • "convertedRunResult": {
    },
  • "sourceRunResult": {
    }
}

convertQuery

クエリを変換する

path パラメータ
projectId
必須
string （id） ^[A-Za-z0-9\-]+$

プロジェクトID

queryId
必須
string （id） ^[A-Za-z0-9\-]+$

クエリ ID

リクエスト ボディ スキーマ: application/json
言語
必須
string (convert-query-言語タイプ)
列挙: "Java" "CSMongoDB" "JavaSCRIPT"
tryTypedEntity
ブール値
デフォルト: false

応答

リクエスト サンプル

コンテンツタイプ
application/ JSON
{
  • "language": "JAVA",
  • "attemptTypedEntities": false
}

応答サンプル

コンテンツタイプ
application/ JSON
{
  • "id": "string",
  • "projectId": "string",
  • "input": {
    },
  • "output": {
    }
}