MongoDB Relational Migrator REST API
Documentos API da Redocly

MongoDB Relational Migrator REST API ()1.11.0

Baixe a especificação OpenAPI:Baixar

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

Especificação OpenAPI para a ferramenta MongoDB Relational Migrator

Codegen

Geração de código com base em mapeamentos de projeto

gerarCode

Gera código de aplicação com base nas regras de mapeamento e transformações de esquema do seu projeto

parâmetros de caminho
projectId
necessário
string (id) ^[A-Za-z0-9\-]+$

ID do Projeto

Esquema do corpo da solicitação: application/json
collections
necessário
Array de strings

Coleções MongoDB para incluir no código gerado

includeSupportFiles
necessário
booleano

Se incluir arquivos de suporte, se aplicável para o idioma e estrutura selecionados

Linguagem
necessário
string (codegen-language-type)
Enum: "JAVA" "CSHARP" "javascript" "JSON" "PYTHON"
Framework
necessário
string (codegen-framework-type)
Enum: "POJO" "POCO" "SPRING_DATA" "PERSISTence_LAYER" "MONGOOSE_SCHEMAS" "NODE" "MONGODB_JSON_SCHEMA" "STANDARD_JSON_SCHEMA" "JSON_EXAMPLE_SCHEMA" "PYTHON_TYPED_DICT_CLASSES"

Respostas

Solicitar amostras

Tipo de conteúdo
aplicação/json
{
  • "collections": [
    ],
  • "includeSupportFiles": true,
  • "language": "JAVA",
  • "framework": "POJO"
}

Exemplos de resposta

Tipo de conteúdo
aplicação/json
{
  • "language": "JAVA",
  • "framework": "POJO",
  • "files": [
    ]
}

getCodegenMetadata

Obtém as linguagens e estruturas disponíveis para geração de código

parâmetros de caminho
projectId
necessário
string (id) ^[A-Za-z0-9\-]+$

ID do Projeto

Respostas

Exemplos de resposta

Tipo de conteúdo
aplicação/json
{
  • "metadata": [
    ]
}

Trabalho

Migração de dados

getJobs

Obter todos os trabalhos de migração

parâmetros de query
sort
string^\w+,(DESC|ASC)$
Padrão: "submittedAt,DESC"
Exemplo: sort=submittedAt,DESC

Ordem na qual recuperar os resultados

limit
inteiro
Exemplo: limit=20

Limite os resultados

type
string (migration-jobs-get-type)
Valor: "IN_PROgress"
Exemplo: type=IN_PROgress

Filtrar trabalhos para apenas de um tipo de tarefa específico

projectId
string (id) ^[A-Za-z0-9\-]+$

Filtrar tarefas por projectId

Respostas

Exemplos de resposta

Tipo de conteúdo
aplicação/json
[
  • {
    }
]

createJob

Postar uma nova tarefa de migração

Esquema do corpo da solicitação: application/json
projectId
necessário
string
necessário
objeto (jdbc-connection-strings)
necessário
objeto (mongodb-connection- Details)
necessário
objeto (migration-job-descriptor-options)
necessário
objeto (migration-verification)
objeto (relational-table-filters)

Esquema

Respostas

Solicitar amostras

Tipo de conteúdo
aplicação/json
{
  • "projectId": "string",
  • "jdbcConnectionDetails": {
    },
  • "mongodbConnectionDetails": {
    },
  • "options": {
    },
  • "verification": {
    },
  • "relationalTableFilters": {
    }
}

Exemplos de resposta

Tipo de conteúdo
aplicação/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

Obtenha o status de um tarefa de migração por ID

parâmetros de caminho
jobId
necessário
string (id) ^[A-Za-z0-9\-]+$

jobId

Respostas

Exemplos de resposta

Tipo de conteúdo
aplicação/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": {
    }
}

pausaJob

Pausar uma tarefa de migração em execução

parâmetros de caminho
jobId
necessário
string (id) ^[A-Za-z0-9\-]+$

jobId

Respostas

Exemplos de resposta

Tipo de conteúdo
aplicação/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

Retomar um tarefa de migração pausado

parâmetros de caminho
jobId
necessário
string (id) ^[A-Za-z0-9\-]+$

jobId

Respostas

Exemplos de resposta

Tipo de conteúdo
aplicação/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

Interromper uma tarefa de migração em execução

parâmetros de caminho
jobId
necessário
string (id) ^[A-Za-z0-9\-]+$

jobId

Respostas

Exemplos de resposta

Tipo de conteúdo
aplicação/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": {
    }
}

Projeto

Captura esquemas e mapeamentos relacionais

getProjects

Obter todos os projetos

parâmetros de query
sort
string^\w+,(DESC|ASC)$
Padrão: "lastModified,DESC"
Exemplo: sort=lastModified,DESC

Ordem na qual recuperar os resultados

Respostas

Exemplos de resposta

Tipo de conteúdo
aplicação/json
[
  • {
    }
]

Query

Conversão de query

getQuerries

Obtenha um resumo de todas as consultas relacionadas a um projeto

parâmetros de caminho
projectId
necessário
string (id) ^[A-Za-z0-9\-]+$

ID do Projeto

Respostas

Exemplos de resposta

Tipo de conteúdo
aplicação/json
[
  • {
    }
]

createQuery

Criar uma nova query adhoc

parâmetros de caminho
projectId
necessário
string (id) ^[A-Za-z0-9\-]+$

ID do Projeto

Esquema do corpo da solicitação: application/json
inputQuery
string

Respostas

Solicitar amostras

Tipo de conteúdo
aplicação/json
{
  • "inputQuery": "string"
}

Exemplos de resposta

Tipo de conteúdo
aplicação/json
{
  • "id": "string",
  • "projectId": "string",
  • "input": {
    },
  • "output": {
    }
}

stopBulkQueryConversion

Interromper uma tarefa de conversão de query em massa

parâmetros de caminho
projectId
necessário
string (id) ^[A-Za-z0-9\-]+$

ID do Projeto

Respostas

Exemplos de resposta

Tipo de conteúdo
aplicação/json
{
  • "pendingQueries": [
    ],
  • "runningQueries": [
    ],
  • "completedQueries": [
    ],
  • "failedQueries": [
    ]
}

getBulkQueryConversion

Obtenha o status de uma tarefa de conversão de query em massa

parâmetros de caminho
projectId
necessário
string (id) ^[A-Za-z0-9\-]+$

ID do Projeto

Respostas

Exemplos de resposta

Tipo de conteúdo
aplicação/json
{
  • "pendingQueries": [
    ],
  • "runningQueries": [
    ],
  • "completedQueries": [
    ],
  • "failedQueries": [
    ]
}

createBulkQueryConversion

Criar um tarefa de conversão de query em massa

parâmetros de caminho
projectId
necessário
string (id) ^[A-Za-z0-9\-]+$

ID do Projeto

Esquema do corpo da solicitação: application/json
Linguagem
necessário
string (convert-query-language-type)
Enum: "JAVA" "CSHARP" "javascript"
queries
necessário
Array de strings
tryTypedEntities
booleano

Respostas

Solicitar amostras

Tipo de conteúdo
aplicação/json
{
  • "language": "JAVA",
  • "queries": [
    ],
  • "attemptTypedEntities": true
}

Exemplos de resposta

Tipo de conteúdo
aplicação/json
{
  • "pendingQueries": [
    ],
  • "runningQueries": [
    ],
  • "completedQueries": [
    ],
  • "failedQueries": [
    ]
}

deleteQuery

Excluir uma query por ID

parâmetros de caminho
projectId
necessário
string (id) ^[A-Za-z0-9\-]+$

ID do Projeto

queryId
necessário
string (id) ^[A-Za-z0-9\-]+$

ID da Consulta

Respostas

Exemplos de resposta

Tipo de conteúdo
aplicação/json
{
  • "jobId": "string",
  • "message": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

getQuery

Obter uma query por ID

parâmetros de caminho
projectId
necessário
string (id) ^[A-Za-z0-9\-]+$

ID do Projeto

queryId
necessário
string (id) ^[A-Za-z0-9\-]+$

ID da Consulta

Respostas

Exemplos de resposta

Tipo de conteúdo
aplicação/json
{
  • "query": {
    },
  • "convertedRunResult": {
    },
  • "sourceRunResult": {
    }
}

convertQuery

Converter uma query

parâmetros de caminho
projectId
necessário
string (id) ^[A-Za-z0-9\-]+$

ID do Projeto

queryId
necessário
string (id) ^[A-Za-z0-9\-]+$

ID da Consulta

Esquema do corpo da solicitação: application/json
Linguagem
necessário
string (convert-query-language-type)
Enum: "JAVA" "CSHARP" "javascript"
tryTypedEntities
booleano
Padrão: false

Respostas

Solicitar amostras

Tipo de conteúdo
aplicação/json
{
  • "language": "JAVA",
  • "attemptTypedEntities": false
}

Exemplos de resposta

Tipo de conteúdo
aplicação/json
{
  • "id": "string",
  • "projectId": "string",
  • "input": {
    },
  • "output": {
    }
}