MongoDB Relational Migrator REST API
Redocly의 API 문서

MongoDB Relational Migrator REST API (1.11.0)

OpenAPI 사양 다운로드: 다운로드

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

MongoDB Relational Migrator 도구에 대한 OpenAPI 사양

Codegen

프로젝트 매핑 기반 코드 생성

generateCode

프로젝트의 매핑 규칙 및 스키마 변환을 기반으로 애플리케이션 코드를 생성합니다.

경로 매개변수
projectId
필수
문자열 (id) ^[A-Za-z0-9\-]+$

프로젝트 ID

요청 본문 스키마: application/json
collections
필수
의 배열 strings

생성된 코드에 포함할 MongoDB 컬렉션

includeSupportFiles
필수
부울

선택한 언어 및 프레임워크 에 해당하는 경우 지원 파일을 포함할지 여부입니다.

언어
필수
문자열 (codegen-language-type)
열거형: "JAVA" "CSHARP" "자바 스크립트" "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
integer
예시: 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
[
  • {
    }
]

쿼리

쿼리 변환

getQuery

프로젝트 와 관련된 모든 쿼리 요약 가져오기

경로 매개변수
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" "자바 스크립트"
쿼리
필수
의 배열 strings
tryTypedEntities
부울

응답

샘플 요청

콘텐츠 유형
application/json
{
  • "language": "JAVA",
  • "queries": [
    ],
  • "attemptTypedEntities": true
}

응답 샘플

콘텐츠 유형
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" "자바 스크립트"
tryTypedEntities
부울
기본값입니다: 거짓

응답

샘플 요청

콘텐츠 유형
application/json
{
  • "language": "JAVA",
  • "attemptTypedEntities": false
}

응답 샘플

콘텐츠 유형
application/json
{
  • "id": "string",
  • "projectId": "string",
  • "input": {
    },
  • "output": {
    }
}