Compartir a través de

Comando

Exporte o genere un archivo de esquema graphQL y guárdelo en el disco. Se admiten dos modos:

  • Captura del esquema existente desde una instancia de tiempo de ejecución de DAB temporal
  • Generación de esquemas a partir de Cosmos DB para NoSQL datos mediante muestreo

Syntax

dab export --graphql -o <output-directory> [options]

Importante

Requiere una configuración de DAB válida. El tipo de base de datos se lee del archivo de configuración. No se acepta ninguna marca.

Vista rápida

Opción Obligatorio Predeterminado Aplicable
--graphql No* false Debe establecerse para la exportación de esquemas.
-o, --output <dir> Sí – Directorio para el esquema de salida
-g, --graphql-schema-file <name> No schema.gql Nombre de archivo colocado dentro del dir de salida
--generate No false Generación de esquemas a partir de datos de Cosmos DB
-m, --sampling-mode <mode> No TopNExtractor Uno de: , ,
-n, --sampling-count <int> No Dependiente del modo Número de registros por modo
--sampling-partition-key-path <path> No – Solo para
-d, --sampling-days <int> No Dependiente del modo Restringir a registros más recientes que N días
--sampling-group-count <int> No (TimePartitionedSampler) Solo para
-c, --config <file> No Específico de env o Ruta de acceso al archivo de configuración
--help No – Mostrar la pantalla de ayuda
--version No – Mostrar información de versión

no es necesario analizar, pero se produce un error en la exportación a menos que la proporcione.

Comportamiento

Mode Description
Exportación del esquema existente Inicia un tiempo de ejecución temporal, introspects esquema GraphQL, escribe el archivo
Generar esquema Ejemplos Azure Cosmos DB para documentos e inferencias de NoSQL esquema

En el modo de exportación (sin ), DAB primero intenta y vuelve a .

El modo de exportación reintenta la recuperación del esquema hasta cinco veces. El modo de generación usa un único intento.

El esquema vacío produce un error: "El esquema de GraphQL generado está vacío. Asegúrese de que los datos están disponibles para generar el esquema".

Modos de muestreo

TopNExtractor

  • Ejemplos N documentos recientes
  • Filtro de hora opcional con

Uso para conjuntos de datos más pequeños y uniformes

EligibleDataSampler

  • Muestreo compatible con particiones
  • N documentos por partición
  • opcional

Uso cuando las particiones tienen un esquema variado

TimePartitionedSampler

  • Divide min/max en grupos de tiempo.
  • N documentos por grupo
  • opcional (valor predeterminado )

Uso cuando el esquema evoluciona con el tiempo

Nota:

Más recursos intensivos debido a varias consultas.

--graphql

Habilita la exportación de esquemas. Sin él, exporta registra un error y no genera un archivo de esquema.

Example

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./schema-out

-o, --output

Directorio para el archivo de esquema. Se crea si falta.

Example

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./schema-out

-g, --graphql-schema-file

Solo nombre de archivo de salida, el valor predeterminado es .

Example

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./out \
  -g custom-schema.gql

--generate

  • false (valor predeterminado): iniciar el tiempo de ejecución, esquema introspect
  • true: Generar esquema a partir de Azure Cosmos DB para los datos de NoSQL

Importante

--generate solo se admite con Azure Cosmos DB para la configuración de NoSQL.

Example

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./schema-gen \
  --generate

-m, --sampling-mode

Opciones: , , Valor predeterminado:

Example

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./schema-gen \
  --generate \
  --sampling-mode TopNExtractor

-n, --sampling-count

  • TopNExtractor: total de documentos
  • EligibleDataSampler: por partición
  • TimePartitionedSampler: por grupo de tiempo

Los valores predeterminados dependen del modo:

  • :
  • :
  • :

Example

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./schema-gen \
  --generate \
  --sampling-mode TopNExtractor \
  --sampling-count 25

--sampling-partition-key-path

Ruta de acceso de la clave de partición para EligibleDataSampler

Example

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./schema-partitions \
  --generate \
  --sampling-mode EligibleDataSampler \
  --sampling-partition-key-path /customerId

-d, --sampling-days

Filtrar documentos por recencia (días)

Los valores predeterminados dependen del modo:

  • : sin límite de tiempo (valor predeterminado )
  • :
  • :

Example

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./schema-gen \
  --generate \
  --sampling-days 14

--sampling-group-count

Número de grupos de tiempo para TimePartitionedSampler

Example

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./schema-time \
  --generate \
  --sampling-mode TimePartitionedSampler \
  --sampling-group-count 8

-c, --config

Ruta de acceso del archivo de configuración. Si se omite:

  1. si se establece env var
  2. De otra manera

Example

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./schema-out \
  --config ./dab-config.json

--help

Muestra la pantalla de ayuda.

Example

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export --help

--version

Mostrar información de versión.

Example

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export --version

Códigos de retorno

Código Meaning
0 Exportación correcta
-1 Error de exportación

Examples

Exportación del esquema existente

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./schema-out

Generar esquema (TopNExtractor)

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./schema-gen \
  --generate \
  --sampling-mode TopNExtractor \
  --sampling-count 25 \
  --sampling-days 14

Muestreo compatible con particiones

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./schema-partitions \
  --generate \
  --sampling-mode EligibleDataSampler \
  --sampling-partition-key-path /customerId \
  --sampling-count 10

Muestreo basado en tiempo

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./schema-time \
  --generate \
  --sampling-mode TimePartitionedSampler \
  --sampling-group-count 8 \
  --sampling-count 5 \
  --sampling-days 60

Nombre de archivo de salida personalizado

  • Bash
  • Símbolo del sistemaCommand Prompt 
dab export \
  --graphql \
  -o ./out \
  -g cosmos-schema.gql \
  --generate \
  --sampling-mode TopNExtractor \
  --sampling-count 15

Uso de archivos generado

Establezca en la ruta de acceso del archivo de esquema exportado. Para obtener más información, consulte Configuración del origen de datos.

Sugerencia

Confirme el esquema generado una vez estable. Vuelva a ejecutarse si cambia el modelo de datos.

Solución de problemas

Síntoma Causa Corrección
Esquema vacío Datos no suficientes o no Agregar datos representativos
Error de conectividad Connection string incorrectas Corrección de credenciales o red
Faltan campos No en documentos muestreados Aumentar el número o el modo de cambio
Pocos resultados de partición Clave de partición incorrecta Proporcionar la ruta de acceso de clave correcta
Muestreo de tiempo lento Conjunto de datos grande Reducir grupos o días

procedimientos recomendados

  • Empezar con TopNExtractor
  • Uso del control de versiones para cambiar el esquema
  • Para colecciones críticas, ejecute varios pasos con parámetros diferentes.
  • Last updated on