MongoDB Relational Migrator REST API
Redocly 提供的 API 文档

MongoDB Relational Migrator REST API ( 1.10.0 )

下载 OpenAPI 规范：下载

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

MongoDB Relational Migrator 工具的 OpenAPI 规范

Codegen

基于项目映射的代码生成

generateCode

根据项目的映射规则和模式转换生成应用程序代码

路径参数
projectId
必需
字符串 (id) ^[A-Za-z0-9\-]+$

项目 ID

请求正文模式：application/json
collections
必需
数组 字符串

要包含在生成代码中的MongoDB集合

includeSupportFiles
必需
布尔

是否包含支持文件（如果适用于所选语言和框架）

语言
必需
字符串 (codegen- language-type )
枚举： "JAVA" "CSHARP" "javascript" "JSON" "PYTHON"
框架
必需
字符串 (codegen-framework-type)
枚举： "POJO" "POCO" "SPRING_DATA" "PERSISTence_LAYER" "MONGOOSE_SCHEMAS" "NODE" "MONGODB_JSON_SCHEMA" "STANDARD_JSON_SCHEMA" "JSON_EXAMPLE_SCHEMA" "PYTHON_TYPED_DICT_CLASSES"

响应

请求样本

内容类型
application/json
{
  • "collections": [
    ],
  • "includeSupportFiles": true,
  • "language": "JAVA",
  • "framework": "POJO"
}

响应样本

内容类型
application/json
{
  • "language": "JAVA",
  • "framework": "POJO",
  • "files": [
    ]
}

getCodegenMetadata

获取可用于代码生成的语言和框架

路径参数
projectId
必需
字符串 (id) ^[A-Za-z0-9\-]+$

项目 ID

响应

响应样本

内容类型
application/json
{
  • "metadata": [
    ]
}

作业

数据迁移

getJobs

获取所有迁移作业

查询参数
sort
字符串^\w+,(DESC|ASC)$
默认： "submittedAt,DESC"
示例： sort=submittedAt,DESC

检索结果的顺序

limit
整型
示例： limit=20

限制结果

类型
字符串 (migration-jobs-get-type)
值： "IN_PROGRESS"
示例： type=IN_PROGRESS

仅筛选特定作业类型的作业

projectId
字符串 (id) ^[A-Za-z0-9\-]+$

按 projectId 筛选职位

响应

响应样本

内容类型
application/json
[
  • {
    }
]

createJob

发布新的迁移作业

请求正文模式：application/json
projectId
必需
字符串
必需
对象 (jdbc-connection-details)
必需
对象 (mongodb-connection-details)
必需
对象 (migration-job-descriptor-options)
必需
对象 (migration-verification)
对象 (relational-table-filters)

架构

响应

请求样本

内容类型
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获取迁移作业的状态

路径参数
jobId
必需
字符串 (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

暂停正在运行的迁移作业

路径参数
jobId
必需
字符串 (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

恢复暂停的迁移作业

路径参数
jobId
必需
字符串 (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

停止运行的迁移作业

路径参数
jobId
必需
字符串 (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
字符串^\w+,(DESC|ASC)$
默认： "lastModified,DESC"
示例： sort=lastModified,DESC

检索结果的顺序

响应

响应样本

内容类型
application/json
[
  • {
    }
]

查询

查询转换

getQueries

获取与项目相关的所有查询的摘要

路径参数
projectId
必需
字符串 (id) ^[A-Za-z0-9\-]+$

项目 ID

响应

响应样本

内容类型
application/json
[
  • {
    }
]

createQuery

创建新的即席查询

路径参数
projectId
必需
字符串 (id) ^[A-Za-z0-9\-]+$

项目 ID

请求正文模式：application/json
inputQuery
字符串

响应

请求样本

内容类型
application/json
{
  • "inputQuery": "string"
}

响应样本

内容类型
application/json
{
  • "id": "string",
  • "projectId": "string",
  • "input": {
    },
  • "output": {
    }
}

stopBulkQueryConversion

停止运行的批量查询转换作业

路径参数
projectId
必需
字符串 (id) ^[A-Za-z0-9\-]+$

项目 ID

响应

响应样本

内容类型
application/json
{
  • "pendingQueries": [
    ],
  • "runningQueries": [
    ],
  • "completedQueries": [
    ],
  • "failedQueries": [
    ]
}

getBulkQueryConversion

获取批量查询转换作业的状态

路径参数
projectId
必需
字符串 (id) ^[A-Za-z0-9\-]+$

项目 ID

响应

响应样本

内容类型
application/json
{
  • "pendingQueries": [
    ],
  • "runningQueries": [
    ],
  • "completedQueries": [
    ],
  • "failedQueries": [
    ]
}

createBulkQueryConversion

创建批量查询转换作业

路径参数
projectId
必需
字符串 (id) ^[A-Za-z0-9\-]+$

项目 ID

请求正文模式：application/json
语言
必需
字符串 (convert-query- language-type)
枚举： "JAVA" "CSHARP" "javascript"
查询
必需
数组 字符串

响应

请求样本

内容类型
application/json
{
  • "language": "JAVA",
  • "queries": [
    ]
}

响应样本

内容类型
application/json
{
  • "pendingQueries": [
    ],
  • "runningQueries": [
    ],
  • "completedQueries": [
    ],
  • "failedQueries": [
    ]
}

deleteQuery

按ID删除查询

路径参数
projectId
必需
字符串 (id) ^[A-Za-z0-9\-]+$

项目 ID

queryId
必需
字符串 (id) ^[A-Za-z0-9\-]+$

查询ID

响应

响应样本

内容类型
application/json
{
  • "jobId": "string",
  • "message": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

getQuery

按ID获取查询

路径参数
projectId
必需
字符串 (id) ^[A-Za-z0-9\-]+$

项目 ID

queryId
必需
字符串 (id) ^[A-Za-z0-9\-]+$

查询ID

响应

响应样本

内容类型
application/json
{
  • "query": {
    },
  • "convertedRunResult": {
    },
  • "sourceRunResult": {
    }
}

convertQuery

转换查询

路径参数
projectId
必需
字符串 (id) ^[A-Za-z0-9\-]+$

项目 ID

queryId
必需
字符串 (id) ^[A-Za-z0-9\-]+$

查询ID

请求正文模式：application/json
语言
必需
字符串 (convert-query- language-type)
枚举： "JAVA" "CSHARP" "javascript"

响应

请求样本

内容类型
application/json
{
  • "language": "JAVA"
}

响应样本

内容类型
application/json
{
  • "id": "string",
  • "projectId": "string",
  • "input": {
    },
  • "output": {
    }
}