Plantillas de configuración de enlace
Obtenga información sobre los formatos de archivo de configuración para cada hundimiento válido y la finalidad de cada parámetro de configuración.
Archivo JSON
The configuration file format for JSON File as a sink of NoSQL Database Migrator is shown below.
Plantilla de configuración
"sink" : {
"type" : "file",
"format" : "json",
"dataPath": "</path/to/a/file>",
"schemaPath" : "<path/to/a/file>",
"pretty" : <true|false>,
"useMultiFiles" : <true|false>,
"chunkSize" : <size in MB>
}
Parámetros de Enlace
type
-
Objetivo: Identifica el tipo de nodo.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
"type" : "file"
formato
-
Objetivo: especifica el formato de nodo.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
"format" : "json"
dataPath
-
Objetivo: especifica la ruta de acceso absoluta a un archivo en el que los datos de origen se copiarán en formato JSON.
Si el archivo no existe en la ruta de datos especificada, el NoSQL Database Migrator lo crea. Si ya existe, el NoSQL Database Migrator sobrescribirá su contenido con los datos de origen.
Debe asegurarse de que el directorio principal para el archivo especificado en la ruta de datos sea válido.
Nota
Si el parámetro useMultiFiles está definido en true, especifique la ruta de acceso a un directorio; de lo contrario, especifique la ruta de acceso al archivo. - Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
- Con el parámetro useMultiFiles definido en true
"dataPath" :"
/home/user/data
" - Con el parámetro useMultiFiles no se ha especificado o se ha definido en false
"dataPath" :"
/home/user/sample.json
"
- Con el parámetro useMultiFiles definido en true
schemaPath
-
Objetivo: especifica la ruta absoluta para escribir la información de esquema proporcionada por el origen.
Si este valor no está definido, la información del esquema de origen no se migrará al nodo. Si se especifica este valor, la utilidad de migración escribe el esquema de la tabla de origen en el archivo especificado aquí.
La información del esquema se escribe como un comando DDL por línea en este archivo. Si el archivo no existe en la ruta de datos especificada, NoSQL Database Migrator lo crea. Si ya existe, NoSQL Database Migrator sobrescribirá su contenido con los datos de origen. Debe asegurarse de que el directorio principal para el archivo especificado en la ruta de datos sea válido.
- Tipo de datos: cadena
- Obligatorio (S/N): N
-
Ejemplo:
"schemaPath" : "/home/user/schema_file"
descriptivo
-
Objetivo: especifica si desea embellecer la salida de JSON para aumentar o no la legibilidad.
Si no se especifica, el valor por defecto es false.
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"pretty" : true
useMultiFiles
-
Objetivo: especifica si se deben dividir o no los datos de la tabla NoSQL en varios archivos al migrar datos de origen a un archivo.
Si no se especifica, el valor por defecto es false.
Si se define en true, al migrar datos de origen a un archivo, los datos de la tabla NoSQL se dividen en varios archivos más pequeños. Por ejemplo,
<chunk>.json
, donde chunk=0000000,000001,000002, etc.dataPath |--000000.json |--000001.json
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"useMultiFiles" : true
chunkSize
-
Objetivo: especifica el tamaño máximo de un "fragmento" de datos de tabla que se almacenará en el fregadero. Durante la migración, una tabla se divide en fragmentos chunkSize y cada fragmento se escribe como un archivo independiente en el disipador. Cuando los datos de origen que se van a migrar superan este tamaño, se crea un nuevo archivo.
Si no se especifica, el valor por defecto es 32MB. El valor válido es un entero entre 1 y 1024.
Nota
Este parámetro se aplica SOLO cuando el parámetro useMultiFiles está definido en true. - Tipo de datos: integer
- Obligatorio (S/N): N
-
Ejemplo:
"chunkSize" : 40
Archivo de Parquet
A continuación, se muestra el formato de archivo de configuración para el archivo Parquet como un sumidero de NoSQL Database Migrator.
Plantilla de Configuración
"sink" : {
"type" : "file",
"format" : "parquet",
"dataPath": "</path/to/a/dir>",
"chunkSize" : <size in MB>,
"compression": "<SNAPPY|GZIP|NONE>",
"parquetOptions": {
"useLogicalJson": <true|false>,
"useLogicalEnum": <true|false>,
"useLogicalUUID": <true|false>,
"truncateDoubleSpecials": <true|false>
}
}
Parámetros de Enlace
type
-
Objetivo: Identifica el tipo de nodo.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
"type" : "file"
formato
-
Objetivo: especifica el formato sink.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
"format" : "parquet"
dataPath
-
Objetivo: especifica la ruta a un directorio que se utilizará para almacenar los datos de la tabla NoSQL migrada. Asegúrese de que el directorio ya existe y tiene permisos de lectura y escritura.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
"dataPath" : "/home/user/migrator/my_table"
chunkSize
-
Objetivo: especifica el tamaño máximo de un "fragmento" de datos de tabla que se almacenará en el fregadero. Durante la migración, una tabla se divide en fragmentos chunkSize y cada fragmento se escribe como un archivo independiente en el disipador. Cuando los datos de origen que se van a migrar superan este tamaño, se crea un nuevo archivo.
Si no se especifica, el valor por defecto es 32MB. El valor válido es un entero entre 1 y 1024.
- Tipo de datos: integer
- Obligatorio (S/N): N
-
Ejemplo:
"chunkSize" : 40
compresión
-
Objetivo: especifica el tipo de compresión que se va a utilizar para comprimir los datos de Parquet. Los valores válidos son SNAPPY, GZIP y NONE.
Si no se especifica, el valor predeterminado es SNAPPY.
- Tipo de datos: cadena
- Obligatorio (S/N): N
-
Ejemplo:
"compression" : "GZIP"
parquetOptions
-
Objetivo: especifica las opciones para seleccionar tipos lógicos de Parquet para las columnas NoSQL ENUM, JSON y UUID.
Si no especifica este parámetro, NoSQL Database Migrator escribe los datos de las columnas ENUM, JSON y UUID como cadena.
- Tipo de dato: objeto
- Obligatorio (S/N): N
parquetOptions.useLogicalJson
-
Objetivo: especifica si se deben escribir o no datos de columna JSON NoSQL como tipo JSON lógico de Parquet. Para obtener más información, consulte Parquet Logical Type Definitions.
Si no se especifica ni se define en false, NoSQL Database Migrator escribe los datos de la columna JSON NoSQL como cadena.
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"useLogicalJson" : true
parquetOptions.useLogicalEnum
-
Objetivo: especifica si se deben escribir o no datos de columna de ENUM NoSQL como tipo de ENUM lógico de Parquet. Para obtener más información, consulte Parquet Logical Type Definitions.
Si no se especifica ni se define como falso, NoSQL Database Migrator escribe los datos de la columna ENUM NoSQL como cadena.
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"useLogicalEnum" : true
parquetOptions.useLogicalUUID
-
Objetivo: especifica si se deben escribir o no datos de la columna UUID NoSQL como tipo de UUID lógico de Parquet. Para obtener más información, consulte Parquet Logical Type Definitions.
Si no se especifica ni se establece en false, NoSQL Database Migrator escribe los datos de la columna UUID NoSQL como String.
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"useLogicalUUID" : true
parquetOptions.truncateDoubleSpecials
-
Objetivo: especifica si se deben truncar o no los valores dobles +Infinity, -Infinity y Nan.
Por defecto, se define enfalse
. Si se define comotrue
,- Positive_Infinity se trunca a Double.MAX_VALUE.
- NEGATIVE_INFINITY se trunca en -Double.MAX_VALUE.
- NaN se trunca a 9.9999999999999990E307.
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"truncateDoubleSpecials" : true
Archivo JSON en bloque de OCI Object Storage
A continuación, se muestra el formato de archivo de configuración para el archivo JSON en el cubo de OCI Object Storage como nodo de NoSQL Database Migrator.
Los tipos de origen válidos para el tipo de origen de OCI Object Storage son
nosqldb
y nosqldb_cloud
.
Plantilla de configuración
"sink" : {
"type" : "object_storage_oci",
"format" : "json",
"endpoint" : "<OCI Object Storage service endpoint URL or region ID>",
"bucket" : "<bucket name>",
"prefix" : "<object prefix>",
"chunkSize" : <size in MB>,
"pretty" : <true|false>,
"credentials" : "</path/to/oci/config/file>",
"credentialsProfile" : "<profile name in oci config file>",
"useInstancePrincipal" : <true|false>
}
Parámetros de origen
type
-
Objetivo: Identifica el tipo de nodo.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
"type" : "object_storage_oci"
formato
-
Objetivo: especifica el formato de hundimiento.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
"format" : "json"
punto final
-
Objetivo: especifica la URL de punto final del servicio de almacenamiento de objetos de OCI o el ID de región.
Puede especificar la URL completa o el ID de región solo. Consulte Regiones de datos y URL de servicio asociadas en Uso de Oracle NoSQL Database Cloud Service para obtener la lista de regiones de datos soportadas para Oracle NoSQL Database Cloud Service.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
-
ID de región:
"endpoint" : "us-ashburn-1"
-
Formato de URL:
"endpoint" : "https://objectstorage.us-ashburn-1.oraclecloud.com"
-
cubo
-
Objetivo: especifica el nombre del cubo que se utilizará para almacenar los datos migrados. Asegúrese de que el cubo necesario ya existe en la instancia de OCI Object Storage y de que tiene permisos de escritura.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
"bucket" : "staging_bucket"
prefijo
-
Objetivo: especifica el prefijo que se agrega al nombre del objeto cuando se crean objetos en el cubo. El prefijo actúa como un contenedor o directorio lógico para almacenar datos. Para obtener más información sobre los prefijos, consulte Nomenclatura de objetos mediante prefijos y jerarquías.
Si no se especifica, el nombre de tabla del origen se utiliza como prefijo. Si ya existe un objeto con el mismo nombre en el cubo, se sobrescribe.
El esquema se migra al archivo
<prefix>/Schema /schema.ddl
y los datos de origen se migran a los archivos<prefix>/Data/<chunk>.json
, donde chunk=000000.json, 000001.json, etc. - Tipo de datos: cadena
- Obligatorio (S/N): N
- Ejemplo:
"prefix" : "my_export"
"prefix" : "my_export/2021-04-05/"
chunkSize
-
Objetivo: especifica el tamaño máximo de un "fragmento" de datos de tabla que se almacenarán en el fregadero. Durante la migración, una tabla se divide en fragmentos chunkSize y cada fragmento se escribe como un archivo independiente en el sumidero. Cuando los datos de origen que se están migrando superan este tamaño, se crea un nuevo archivo.
Si no se especifica, el valor por defecto es 32 MB. El valor válido es un entero entre 1 y 1024.
- Tipo de datos: integer
- Obligatorio (S/N): N
-
Ejemplo:
"chunkSize" : 40
descriptivo
-
Objetivo: especifica si desea embellecer la salida de JSON para aumentar o no la legibilidad.
Si no se especifica, el valor por defecto es false.
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"pretty" : true
credenciales
-
Objetivo: ruta absoluta a un archivo que contiene credenciales de OCI.
Si no se especifica, el valor por defecto es
$HOME/.oci/config
Consulte Configuración de ejemplo para ver un ejemplo del archivo de credenciales.
Nota
Aunque los parámetros credentials y useInstancePrincipal no son obligatorios de forma individual, se debe especificar uno de estos parámetros. Además, estos dos parámetros son mutuamente excluyentes. Especifique SOLO uno de estos parámetros, pero no ambos al mismo tiempo. - Tipo de datos: cadena
- Obligatorio (S/N): N
- Ejemplo:
"credentials" : "/home/user/.oci/config"
"credentials" : "/home/user/security/config"
credentialsProfile
-
Objetivo: nombre del perfil de configuración que se utilizará para conectarse a Oracle NoSQL Database Cloud Service. A las credenciales de la cuenta de usuario se les conoce como "archivo".
Si no especifica este valor, se define por defecto en el perfil
DEFAULT
.Nota
Este parámetro es válido SOLO si se especifica el parámetro credentials. - Tipo de datos: cadena
- Obligatorio (S/N): N
- Ejemplo:
"credentialsProfile" : "DEFAULT"
"credentialsProfile": "ADMIN_USER"
useInstancePrincipal
-
Objetivo: especifica si la herramienta de migrador NoSQL utiliza la autenticación de principal de instancia para conectarse a Oracle NoSQL Database Cloud Service. Para obtener más información sobre el método de autenticación de principal de instancia, consulte Seguridad de origen y de enlace.
Si no se especifica, el valor por defecto es false.
Nota
- SOLO se admite cuando la herramienta NoSQL Database Migrator se ejecuta en una instancia informática de OCI, por ejemplo, la herramienta NoSQL Database Migrator que se ejecuta en una máquina virtual alojada en OCI.
- Aunque los parámetros credentials y useInstancePrincipal no son obligatorios de forma individual, se debe especificar uno de estos parámetros. Además, estos dos parámetros son mutuamente excluyentes. Especifique SOLO uno de estos parámetros, pero no ambos al mismo tiempo.
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"useInstancePrincipal" : true
Archivo Parquet en el cubo de almacenamiento de objetos de OCI
A continuación, se muestra el formato de archivo de configuración para el archivo Parquet en el cubo de OCI Object Storage como un sumidero de NoSQL Database Migrator.
Los tipos de origen válidos para el tipo de origen de OCI Object Storage son
nosqldb
y nosqldb_cloud
.
Plantilla de Configuración
"sink" : {
"type" : "object_storage_oci",
"format" : "parquet",
"endpoint" : "<OCI Object Storage service endpoint URL or region ID>",
"bucket" : "<bucket name>",
"prefix" : "<object prefix>",
"chunkSize" : <size in MB>,
"compression": "<SNAPPY|GZIP|NONE>",
"parquetOptions": {
"useLogicalJson": <true|false>,
"useLogicalEnum": <true|false>,
"useLogicalUUID": <true|false>,
"truncateDoubleSpecials": <true|false>
},
"credentials" : "</path/to/oci/config/file>",
"credentialsProfile" : "<profile name in oci config file>",
"useInstancePrincipal" : <true|false>
}
Parámetros de origen
type
-
Objetivo: Identifica el tipo de nodo.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
"type" : "object_storage_oci"
formato
-
Objetivo: especifica el formato de hundimiento.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
"format" : "parquet"
punto final
-
Objetivo: especifica la URL de punto final del servicio OCI Object Storage o el ID de región.
Puede especificar la URL completa o el ID de región solo. Consulte Regiones de datos y URL de servicio asociado en Uso de Oracle NoSQL Database Cloud Service para obtener la lista de regiones de datos soportadas para Oracle NoSQL Database Cloud Service.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
-
ID de región:
"endpoint" : "us-ashburn-1"
-
Formato de URL:
"endpoint" : "https://objectstorage.us-ashburn-1.oraclecloud.com"
-
cubo
-
Objetivo: especifica el nombre del cubo que se utilizará para almacenar los datos migrados. Asegúrese de que el cubo necesario ya existe en la instancia de OCI Object Storage y de que tiene permisos de escritura.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
"bucket" : "staging_bucket"
prefijo
-
Objetivo: especifica el prefijo que se agrega al nombre del objeto cuando se crean objetos en el cubo. El prefijo actúa como un contenedor lógico o directorio para almacenar datos. Para obtener más información sobre los prefijos, consulte Nomenclatura de objetos mediante prefijos y jerarquías.
Si no se especifica, el nombre de la tabla del origen se utiliza como prefijo. Si ya existe un objeto con el mismo nombre en el cubo, se sobrescribe.
Los datos de origen se migran a los archivos
<prefix>/Data/<chunk>.parquet
, donde fragmento=000000.parquet, 000001.parquet, etc. - Tipo de datos: cadena
- Obligatorio (S/N): N
- Ejemplo:
"prefix" : "my_export"
"prefix" : "my_export/2021-04-05/"
chunkSize
-
Objetivo: especifica el tamaño máximo de un "fragmento" de datos de tabla que se almacenarán en el fregadero. Durante la migración, una tabla se divide en fragmentos chunkSize y cada fragmento se escribe como un archivo independiente en el sumidero. Cuando los datos de origen que se están migrando superan este tamaño, se crea un nuevo archivo.
Si no se especifica, el valor por defecto es 32 MB. El valor válido es un entero entre 1 y 1024.
- Tipo de datos: entero
- Obligatorio (S/N): N
-
Ejemplo:
"chunkSize" : 40
compresión
-
Objetivo: especifica el tipo de compresión que se va a utilizar para comprimir los datos de Parquet. Los valores válidos son SNAPPY, GZIP y NONE.
Si no se especifica, el valor predeterminado es SNAPPY.
- Tipo de datos: cadena
- Obligatorio (S/N): N
-
Ejemplo:
"compression" : "GZIP"
parquetOptions
-
Objetivo: especifica las opciones para seleccionar tipos lógicos de Parquet para las columnas NoSQL ENUM, JSON y UUID.
Si no especifica este parámetro, NoSQL Database Migrator escribe los datos de las columnas ENUM, JSON y UUID como cadena.
- Tipo de dato: objeto
- Obligatorio (S/N): N
parquetOptions.useLogicalJson
-
Objetivo: especifica si se deben escribir o no datos de columna JSON NoSQL como tipo JSON lógico de Parquet. Para obtener más información, consulte Parquet Logical Type Definitions.
Si no se especifica ni se define en false, NoSQL Database Migrator escribe los datos de la columna JSON NoSQL como cadena.
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"useLogicalJson" : true
parquetOptions.useLogicalEnum
-
Objetivo: especifica si se deben escribir o no datos de columna de ENUM NoSQL como tipo de ENUM lógico de Parquet. Para obtener más información, consulte Parquet Logical Type Definitions.
Si no se especifica ni se define como falso, NoSQL Database Migrator escribe los datos de la columna ENUM NoSQL como cadena.
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"useLogicalEnum" : true
parquetOptions.useLogicalUUID
-
Objetivo: especifica si se deben escribir o no datos de la columna UUID NoSQL como tipo de UUID lógico de Parquet. Para obtener más información, consulte Parquet Logical Type Definitions.
Si no se especifica ni se establece en false, NoSQL Database Migrator escribe los datos de la columna UUID NoSQL como String.
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"useLogicalUUID" : true
parquetOptions.truncateDoubleSpecials
-
Objetivo: especifica si se deben truncar o no los valores dobles +Infinity, -Infinity y Nan.
Por defecto, se define enfalse
. Si se define comotrue
,- Positive_Infinity se trunca a Double.MAX_VALUE.
- NEGATIVE_INFINITY se trunca en -Double.MAX_VALUE.
- NaN se trunca a 9.9999999999999990E307.
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"truncateDoubleSpecials" : true
credenciales
-
Objetivo: ruta absoluta a un archivo que contiene credenciales de OCI.
Si no se especifica, el valor por defecto es
$HOME/.oci/config
Consulte Configuración de ejemplo para ver un ejemplo del archivo de credenciales.
Nota
Aunque los parámetros credentials y useInstancePrincipal no son obligatorios de forma individual, se debe especificar uno de estos parámetros. Además, estos dos parámetros son mutuamente excluyentes. Especifique SOLO uno de estos parámetros, pero no ambos al mismo tiempo. - Tipo de datos: cadena
- Obligatorio (S/N): N
- Ejemplo:
"credentials" : "/home/user/.oci/config"
"credentials" : "/home/user/security/config"
credentialsProfile
-
Objetivo: nombre del perfil de configuración que se utilizará para conectarse a Oracle NoSQL Database Cloud Service. Las credenciales de la cuenta de usuario se denominan "profile".
Si no especifica este valor, se define por defecto en el perfil
DEFAULT
.Nota
Este parámetro es válido SOLO si se especifica el parámetro credentials. - Tipo de datos: cadena
- Obligatorio (S/N): N
- Ejemplo:
"credentialsProfile" : "DEFAULT"
"credentialsProfile": "ADMIN_USER"
useInstancePrincipal
-
Objetivo: especifica si la herramienta Migrator NoSQL utiliza la autenticación de principal de instancia para conectarse a Oracle NoSQL Database Cloud Service. Para obtener más información sobre el método de autenticación de principal de instancia, consulte Source and Sink Security.
Si no se especifica, el valor por defecto es false.
Nota
- SOLO se admite cuando la herramienta NoSQL Database Migrator se ejecuta en una instancia informática de OCI, por ejemplo, la herramienta NoSQL Database Migrator que se ejecuta en una máquina virtual alojada en OCI.
- Aunque los parámetros credentials y useInstancePrincipal no son obligatorios de forma individual, se debe especificar uno de estos parámetros. Además, estos dos parámetros son mutuamente excluyentes. Especifique SOLO uno de estos parámetros, pero no ambos al mismo tiempo.
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"useInstancePrincipal" : true
Oracle NoSQL Database
A continuación, se muestra el formato de archivo de configuración para Oracle NoSQL Database como sumidero de NoSQL Database Migrator.
Plantilla de configuración
"sink" : {
"type": "nosqldb",
"table" : "<fully qualified table name>",
"schemaInfo" : {
"schemaPath" : "</path/to/a/schema/file>",
"defaultSchema" : <true|false>,
"useSourceSchema" : <true|false>
},
"overwrite" : <true|false>,
"storeName" : "<store name>",
"helperHosts" : ["hostname1:port1","hostname2:port2,..."],
"security" : "</path/to/store/credentials/file>",
"requestTimeoutMs" : <timeout in milli seconds>,
"includeTTL": <true|false>,
"ttlRelativeDate": "<date-to-use in UTC>"
}
Parámetros de Enlace
tipo
-
Objetivo: identifica el tipo de fregadero.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
"type" : "nosqldb"
tabla
-
Objetivo: Nombre de tabla totalmente cualificado desde el que migrar los datos.
Formato:
[namespace_name:]<table_name>
Si la tabla está en el espacio de nombres DEFAULT, puede omitir
namespace_name
. La tabla debe existir en el almacén durante la migración y su esquema debe coincidir con los datos de origen.Si la tabla no está disponible en el disipador, puede utilizar el parámetro
schemaInfo
para indicar al NoSQL Database Migrator que cree la tabla también en el disipador. - Tipo de datos: cadena
- Obligatorio (S/N): Y
- Ejemplo:
-
Con el espacio de nombres DEFAULT
"table" :"mytable"
-
Con un espacio de nombres no predeterminado
"table" : "mynamespace:mytable"
-
schemainfo
-
Objetivo: especifica el esquema para los datos que se van a migrar. Si no se especifica, asume que la tabla ya existe en la tienda del fregadero.
- Tipo de datos: objeto
- Obligatorio (S/N): N
schemaInfo.schemaPath
-
Objetivo: especifica la ruta absoluta a un archivo que contiene sentencias DDL para la tabla NoSQL.
El NoSQL Database Migrator ejecuta los comandos DDL que se muestran en este archivo antes de migrar los datos.
El NoSQL Database Migrator no soporta más de una sentencia DDL por línea en el archivo
schemaPath
. -
Tipo de datos: cadena
-
Obligatorio: Y, sólo cuando el parámetro
schemaInfo.defaultSchema
se establece en No.
schemaInfo.defaultSchema
-
Objetivo: la definición de este parámetro en true indica al NoSQL Database Migrator que cree una tabla con el esquema predeterminado. El esquema por defecto lo define el propio migrador. Para obtener más información sobre las definiciones de esquema por defecto, consulte Esquema por defecto.
-
Tipo de datos: booleano
-
Obligatorio: Y, sólo cuando el parámetro
schemaInfo.defaultSchema
se establece en No.Nota
:defaultSchema
yschemaPath
se excluyen mutuamente - Ejemplo:
- Con Esquema por Defecto:
"schemaInfo" : { "defaultSchema" : true }
- Con un esquema predefinido:
"schemaInfo" : { "schemaPath" : "<complete/path/to/the/schema/definition/file>" }
- Con Esquema por Defecto:
schemaInfo.useSourceSchema
-
Objetivo: especifica si el disipador utiliza o no la definición de esquema de tabla proporcionada por el origen al migrar tablas NoSQL.
-
Tipo de datos: booleano
- Obligatorio (S/N): N
Nota
Los parámetros defaultSchema, schemaPath y useSourceSchema se excluyen mutuamente. Especifique SOLO uno de estos parámetros. - Ejemplo:
- Con el esquema por defecto:
"schemaInfo" : { "defaultSchema" : true }
- Con un esquema predefinido:
"schemaInfo" : { "schemaPath" : "<complete/path/to/the/schema/definition/file>" }
- Con el esquema de origen:
"schemaInfo" : { "useSourceSchema" : true }
- Con el esquema por defecto:
sobrescribir
-
Objetivo: indica el comportamiento del NoSQL Database Migrator cuando el registro que se está migrando desde el origen ya está presente en el disipador.
Si el valor se establece en false, al migrar tablas, NoSQL Database Migrator omite los registros para los que ya existe la misma clave primaria en el disipador.
Si el valor se establece en true, al migrar tablas, NoSQL Database Migrator sobrescribe los registros para los que ya existe la misma clave primaria en el disipador.
Si no se especifica, el valor por defecto es true.
- Tipo de datos: booleano
- Obligatorio (S/N): N
- Ejemplo:
"overwrite" : false
storeName
-
Objetivo: nombre del almacén de Oracle NoSQL Database.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
- Ejemplo:
"storeName" : "kvstore"
helperHosts
-
Objetivo: lista de pares de puertos de host y registro con el formato
hostname:port
. Delimite cada elemento de la lista con una coma. Debe especificar al menos un host auxiliar. - Tipo de datos: matriz de cadenas
- Obligatorio (S/N): Y
- Ejemplo:
"helperHosts" : ["localhost:5000","localhost:6000"]
seguridad
-
Objetivo:
Si su almacén es un almacén seguro, proporcione la ruta de acceso absoluta al archivo de conexión de seguridad que contiene las credenciales de su almacén. Consulte Configuring Security with Remote Access in Administrator's Guide para obtener más información sobre el archivo de inicio de sesión de seguridad.
Puede utilizar la autenticación basada en archivo de contraseñas o la autenticación basada en cartera. Sin embargo, la autenticación basada en cartera solo está soportada en Enterprise Edition (EE) de Oracle NoSQL Database. Para obtener más información sobre la autenticación basada en carteras, consulte Seguridad del origen y el enlace.
- Tipo de datos: cadena
- Obligatorio (S/N): Y para un almacén seguro
- Ejemplo:
"security" : "
/home/user/client.credentials
"Ejemplo de contenido de archivo de seguridad para la autenticación basada en archivo de contraseñas:
oracle.kv.password.noPrompt=true oracle.kv.auth.username=admin oracle.kv.auth.pwdfile.file=/home/nosql/login.passwd oracle.kv.transport=ssl oracle.kv.ssl.trustStore=/home/nosql/client.trust oracle.kv.ssl.protocols=TLSv1.2 oracle.kv.ssl.hostnameVerifier=dnmatch(CN\=NoSQL)
Ejemplo de contenido de archivo de seguridad para la autenticación basada en cartera:
oracle.kv.password.noPrompt=true oracle.kv.auth.username=admin oracle.kv.auth.wallet.dir=/home/nosql/login.wallet oracle.kv.transport=ssl oracle.kv.ssl.trustStore=/home/nosql/client.trust oracle.kv.ssl.protocols=TLSv1.2 oracle.kv.ssl.hostnameVerifier=dnmatch(CN\=NoSQL)
requestTimeoutMs
-
Objetivo: especifica el tiempo que se debe esperar a que finalice cada operación de escritura en el disipador. Esto se proporciona en milisegundos. El valor por defecto es 5000. El valor puede ser cualquier entero positivo.
- Tipo de datos: entero
- Obligatorio (S/N): N
- Ejemplo:
"requestTimeoutMs" : 5000
includeTTL
-
Objetivo: especifica si se deben incluir o no metadatos TTL para las filas de tabla proporcionadas por el origen al importar tablas de Oracle NoSQL Database.
Si no se especifica este parámetro, el valor por defecto es
false
. En ese caso, NoSQL Database Migrator no incluye metadatos TTL para las filas de tabla proporcionadas por el origen al importar tablas de Oracle NoSQL Database.Si se define en true, la herramienta NoSQL Database Migrator realiza las siguientes comprobaciones en los metadatos de TTL al importar una fila de tabla:- Si importa una fila que no tiene una definición
_metadata
, la herramienta NoSQL Database Migrator define el TTL en 0, lo que significa que la fila nunca caduca. - Si importa una fila que tiene la definición
_metadata
, la herramienta NoSQL Database Migrator compara el valor TTL con una hora de referencia cuando se importa una fila. Si la fila ya ha caducado en relación con la hora de referencia, se omite. Si la fila no ha caducado, se importa junto con el valor TTL. Por defecto, el tiempo de referencia de la operación de importación es el tiempo actual en milisegundos, obtenido de System.currentTimeMillis(), del equipo en el que se ejecuta la herramienta NoSQL Database Migrator. Sin embargo, también puede definir un tiempo de referencia personalizado mediante el parámetro de configuraciónttlRelativeDate
si desea ampliar el tiempo de caducidad e importar filas que, de lo contrario, caducarán inmediatamente.La fórmula para calcular el tiempo de caducidad de una fila es la siguiente:expiration = (TTL value of source row in milliseconds - Reference Time in milliseconds) if (expiration <= 0) then it indicates that row has expired.
Nota
Dado que los límites de TTL de Oracle NoSQL son en horas y días, en algunos casos, el TTL de la fila importada se puede ajustar a la hora o el día más cercanos. Por ejemplo, considere que una fila que tenga el valor de caducidad1629709200000 (2021-08-23 09:00:00)
y el valor de Hora de referencia es1629707962582 (2021-08-23 08:39:22)
. Aquí, aunque la fila no haya caducado en relación con la hora de referencia cuando se importan estos datos, el nuevo TTL para la fila es1629712800000 (2021-08-23 10:00:00)
.
- Si importa una fila que no tiene una definición
- Tipo de datos: booleano
- Obligatorio (S/N): N
- Ejemplo:
"includeTTL" : true
ttlRelativeDate
-
Objetivo: especifique una fecha UTC con el formato AAAA-MM-DD hh:mm:ss utilizado para definir la caducidad de TTL de las filas de la tabla durante la importación a Oracle NoSQL Database.
Si una fila de tabla de los datos que está exportando ha caducado, puede definir el parámetro ttlRelativeDate en una fecha anterior a la hora de caducidad de la fila de tabla de los datos exportados.
Si no especifica este parámetro, se establece por defecto en la hora actual en milisegundos, obtenida de System.currentTimeMillis(), del equipo en el que se ejecuta la herramienta NoSQL Database Migrator.
- Tipo de datos: fecha
- Obligatorio (S/N): N
- Ejemplo:
"ttlRelativeDate" : "2021-01-03 04:31:17"
Consideremos un escenario en el que las filas de la tabla caducan después de siete días a partir del 1 de enero de 2021. Después de exportar esta tabla, el 7 de enero de 2021, se produce un problema con la tabla y decide importar los datos. Las filas de la tabla caducarán en un día (la fecha de caducidad de los datos menos el valor por defecto del parámetro de configuración ttlRelativedate, que es la fecha actual). Sin embargo, si desea ampliar la fecha de caducidad de las filas de la tabla a cinco días en lugar de a un día, utilice el parámetro ttlRelativeDate y elija una fecha anterior. Por lo tanto, en este escenario si desea ampliar el tiempo de caducidad de las filas de la tabla en cinco días, defina el valor de los parámetros de configuración ttlRelativeDate en 3-Ene-2021, que se utiliza como Hora de referencia cuando se importan las filas de la tabla.
Oracle NoSQL Database Cloud Service
A continuación, se muestra el formato de archivo de configuración de Oracle NoSQL Database Cloud Service como nodo principal de NoSQL Database Migrator.
Plantilla de configuración
"sink" : {
"type" : "nosqldb_cloud",
"endpoint" : "<Oracle NoSQL Cloud Service Endpoint>",
"table" : "<table name>",
"compartment" : "<OCI compartment name or id>",
"schemaInfo" : {
"schemaPath" : "</path/to/a/schema/file>",
"defaultSchema" : <true|false>,
"useSourceSchema" : <true|false>,
"readUnits" : <table read units>,
"writeUnits" : <table write units>,
"storageSize" : <storage size in GB>
},
"credentials" : "</path/to/oci/credential/file>",
"credentialsProfile" : "<oci credentials profile name>",
"writeUnitsPercent" : <table writeunits percent>,
"requestTimeoutMs" : <timeout in milli seconds>,
"useInstancePrincipal" : <true|false>,
"overwrite" : <true|false>,
"includeTTL": <true|false>,
"ttlRelativeDate" : "<date-to-use in UTC>"
}
Parámetros de enlace
- type
- punto final
- tabla
- compartimento
- schemaInfo
- schemaInfo.schemaPath
- schemaInfo.defaultSchema
- schemaInfo.useSourceSchema
- schemaInfo.readUnits
- schemaInfo.writeUnits
- schemaInfo.storageSize
- credenciales
- credentialsProfile
- writeUnitsPercent
- requestTimeoutMs
- useInstancePrincipal
- sobrescribir
- includeTTL
- ttlRelativeDate
tipo
-
Objetivo: identifica el tipo de fregadero.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
"type" : "nosqldb_cloud"
punto final
-
Objetivo: especifica el punto final de servicio de Oracle NoSQL Database Cloud Service.
Puede especificar solo la URL completa o el ID de región. Consulte Regiones de datos y URL de servicio asociado en Uso de Oracle NoSQL Database Cloud Service para obtener la lista de regiones de datos soportadas para Oracle NoSQL Database Cloud Service.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
-
Ejemplo:
-
ID de región:
"endpoint" : "us-ashburn-1"
-
Formato de URL:
"endpoint" : "https://nosql.us-ashburn-1.oci.oraclecloud.com/"
-
tabla
-
Objetivo: nombre de la tabla a la que migrar los datos.
Debe asegurarse de que esta tabla exista en Oracle NoSQL Database Cloud Service. De lo contrario, debe utilizar el objeto
schemaInfo
en la configuración sink para indicar al NoSQL Database Migrator que cree la tabla.El esquema de esta tabla debe coincidir con los datos de origen.
- Tipo de datos: cadena
- Obligatorio (S/N): Y
- Ejemplo:
"table" :"myTable"
compartimento
-
Objetivo: especifica el nombre o el OCID del compartimento en el que reside la tabla.
Si no proporciona ningún valor, se establece por defecto en el compartimento root.
Puede encontrar el OCID del compartimento en la ventana Explorador de compartimentos, en Governance, en la consola de OCI Cloud.
- Tipo de datos: cadena
- Obligatorio (S/N): Y si la tabla no está en el compartimento raíz del arrendamiento O si el parámetro useInstancePrincipal está definido en true.
Nota
Si el parámetro useInstancePrincipal está definido en true, el compartimento debe especificar el OCID de compartimento y no el nombre. - Ejemplo:
-
Nombre de compartimento
"compartment" : "mycompartment"
-
Nombre de compartimento cualificado con su compartimento principal
"compartment" : "parent.childcompartment"
-
No se ha proporcionado ningún valor. El valor predeterminado es el compartimento raíz.
"compartment": ""
-
OCID de compartimento
"compartment" : "ocid1.tenancy.oc1...4ksd"
-
schemaInfo
-
Objetivo: especifica el esquema para los datos que se van a migrar.
Si no especifica este parámetro, el NoSQL Database Migrator asume que la tabla ya existe en Oracle NoSQL Database Cloud Service.
Si no se especifica este parámetro y la tabla no existe en el disipador, la migración falla.
- Tipo de datos: objeto
- Obligatorio (S/N): N
schemaInfo.schemaPath
-
Objetivo: especifica la ruta absoluta a un archivo que contiene sentencias DDL para la tabla NoSQL.
El NoSQL Database Migrator ejecuta los comandos DDL que se muestran en este archivo antes de migrar los datos.
El NoSQL Database Migrator no soporta más de una sentencia DDL por línea en el archivo
schemaPath
. -
Tipo de datos: cadena
-
Obligatorio: Y, sólo cuando el parámetro
schemaInfo.defaultSchema
se establece en No.
schemaInfo.defaultSchema
-
Objetivo: la definición de este parámetro en Sí indica al NoSQL Database Migrator que cree una tabla con el esquema predeterminado. El esquema por defecto lo define el propio migrador. Para obtener más información sobre las definiciones de esquema por defecto, consulte Esquema por defecto.
-
Tipo de datos: booleano
-
Obligatorio: Y, sólo cuando el parámetro
schemaInfo.defaultSchema
se establece en No.Nota
:defaultSchema
yschemaPath
se excluyen mutuamente
schemaInfo.useSourceSchema
-
Objetivo: especifica si el disipador utiliza o no la definición de esquema de tabla proporcionada por el origen al migrar tablas NoSQL.
-
Tipo de datos: booleano
- Obligatorio (S/N): N
Nota
Los parámetros defaultSchema, schemaPath y useSourceSchema se excluyen mutuamente. Especifique SOLO uno de estos parámetros. - Ejemplo:
- Con esquema por defecto:
"schemaInfo" : { "defaultSchema" : true, "readUnits" : 100, "writeUnits" : 60, "storageSize" : 1 }
- Con un esquema predefinido:
"schemaInfo" : { "schemaPath" : "<complete/path/to/the/schema/definition/file>", "readUnits" : 100, "writeUnits" : 100, "storageSize" : 1 }
- Con el esquema de origen:
"schemaInfo" : { "useSourceSchema" : true, "readUnits" : 100, "writeUnits" : 60, "storageSize" : 1 }
- Con esquema por defecto:
schemaInfo.readUnits
- Objetivo: especifica el rendimiento de lectura de la nueva tabla.
-
Tipo de datos: entero
-
Obligatorio: Y
schemaInfo.writeUnits
- Objetivo: especifica el rendimiento de escritura de la nueva tabla.
-
Tipo de datos: entero
-
Obligatorio: Y
schemaInfo.storageSize
- Objetivo: especifica el tamaño de almacenamiento de la nueva tabla en GB
-
Tipo de datos: entero
-
Obligatorio: Y
- Ejemplo:
-
Con
schemaPath
"schemaInfo" : { "schemaPath" : "</path/to/a/schema/file>", "readUnits" : 500, "writeUnits" : 1000, "storageSize" : 5 }
-
Con
defaultSchema
"schemaInfo" : { "defaultSchema" :Yes, "readUnits" : 500, "writeUnits" : 1000, "storageSize" : 5 }
-
credenciales
-
Objetivo: ruta de acceso absoluta a un archivo que contiene credenciales de OCI.
Si no se especifica, el valor por defecto es
$HOME/.oci/config
Consulte Example Configuration para obtener un ejemplo del archivo de credenciales.
Nota
Aunque los parámetros credentials y useInstancePrincipal no son obligatorios individualmente, se DEBE especificar uno de estos parámetros. Además, estos dos parámetros son mutuamente excluyentes. Especifique SOLO uno de estos parámetros, pero no ambos al mismo tiempo. - Tipo de datos: cadena
- Obligatorio (S/N): N
- Ejemplo:
"credentials" : "/home/user/.oci/config"
"credentials" : "/home/user/security/config"
credentialsProfile
-
Objetivo: nombre del perfil de configuración que se utilizará para conectarse a Oracle NoSQL Database Cloud Service.
Si no especifica este valor, se define por defecto en el perfil
DEFAULT
.Nota
Este parámetro es válido SOLO si se especifica el parámetro credentials. - Tipo de datos: cadena
- Obligatorio (S/N): N
- Ejemplo:
"credentialsProfile" : "DEFAULT"
"credentialsProfile": "ADMIN_USER"
writeUnitsPercent
-
Objetivo: especifica el porcentaje de unidades de escritura de tabla que se utilizarán durante la actividad de migración.
El valor por defecto es 90. El rango válido es cualquier entero entre 1 y 100.
Nota
El tiempo necesario para la migración de datos es directamente proporcional al valorwriteUnitsPercent
.Consulte Solución de problemas del migrador de Oracle NoSQL Database para obtener más información sobre cómo utilizar este atributo para mejorar la velocidad de migración de datos.
- Tipo de datos: entero
- Obligatorio (S/N): N
- Ejemplo:
"writeUnitsPercent" : 90
requestTimeoutMs
-
Objetivo: especifica el tiempo que se debe esperar a que finalice cada operación de escritura en el disipador. Esto se proporciona en milisegundos. El valor por defecto es 5000. El valor puede ser cualquier entero positivo.
- Tipo de datos: entero
- Obligatorio (S/N): N
- Ejemplo:
"requestTimeoutMs" : 5000
useInstancePrincipal
-
Objetivo: especifica si la herramienta de migrador NoSQL utiliza la autenticación de principal de instancia para conectarse a Oracle NoSQL Database Cloud Service. Para obtener más información sobre el método de autenticación de principal de instancia, consulte Seguridad de origen y de enlace.
Si no se especifica, el valor por defecto es false.
Nota
- Se admite SOLO cuando la herramienta NoSQL Database Migrator se ejecuta en una instancia informática de OCI, por ejemplo, la herramienta NoSQL Database Migrator que se ejecuta en una VM alojada en OCI.
- Aunque los parámetros credentials y useInstancePrincipal no son obligatorios individualmente, se DEBE especificar uno de estos parámetros. Además, estos dos parámetros son mutuamente excluyentes. Especifique SOLO uno de estos parámetros, pero no ambos al mismo tiempo.
- Tipo de datos: booleano
- Obligatorio (S/N): N
-
Ejemplo:
"useInstancePrincipal" : true
sobrescribir
-
Objetivo: indica el comportamiento del NoSQL Database Migrator cuando el registro que se está migrando desde el origen ya está presente en el disipador.
Si el valor se establece en false, al migrar tablas, NoSQL Database Migrator omite los registros para los que ya existe la misma clave primaria en el disipador.
Si el valor se establece en true, al migrar tablas, NoSQL Database Migrator sobrescribe los registros para los que ya existe la misma clave primaria en el disipador.
Si no se especifica, el valor por defecto es true.
- Tipo de datos: booleano
- Obligatorio (S/N): N
- Ejemplo:
"overwrite" : false
includeTTL
-
Objetivo: especifica si se deben incluir o no metadatos TTL para las filas de tabla proporcionadas por el origen al importar tablas de Oracle NoSQL Database.
Si no se especifica este parámetro, el valor por defecto es
false
. En ese caso, NoSQL Database Migrator no incluye metadatos TTL para las filas de tabla proporcionadas por el origen al importar tablas de Oracle NoSQL Database.Si se define en true, la herramienta NoSQL Database Migrator realiza las siguientes comprobaciones en los metadatos de TTL al importar una fila de tabla:- Si importa una fila que no tiene una definición
_metadata
, la herramienta NoSQL Database Migrator define el TTL en 0, lo que significa que la fila nunca caduca. - Si importa una fila que tiene la definición
_metadata
, la herramienta NoSQL Database Migrator compara el valor TTL con una hora de referencia cuando se importa una fila. Si la fila ya ha caducado en relación con la hora de referencia, se omite. Si la fila no ha caducado, se importa junto con el valor TTL. Por defecto, el tiempo de referencia de la operación de importación es el tiempo actual en milisegundos, obtenido de System.currentTimeMillis(), del equipo en el que se ejecuta la herramienta NoSQL Database Migrator. Sin embargo, también puede definir un tiempo de referencia personalizado mediante el parámetro de configuraciónttlRelativeDate
si desea ampliar el tiempo de caducidad e importar filas que, de lo contrario, caducarán inmediatamente.La fórmula para calcular el tiempo de caducidad de una fila es la siguiente:expiration = (TTL value of source row in milliseconds - Reference Time in milliseconds) if (expiration <= 0) then it indicates that row has expired.
Nota
Dado que los límites de TTL de Oracle NoSQL son en horas y días, en algunos casos, el TTL de la fila importada se puede ajustar a la hora o el día más cercanos. Por ejemplo, considere que una fila que tenga el valor de caducidad1629709200000 (2021-08-23 09:00:00)
y el valor de Hora de referencia es1629707962582 (2021-08-23 08:39:22)
. Aquí, aunque la fila no haya caducado en relación con la hora de referencia cuando se importan estos datos, el nuevo TTL para la fila es1629712800000 (2021-08-23 10:00:00)
.
- Si importa una fila que no tiene una definición
- Tipo de datos: booleano
- Obligatorio (S/N): N
- Ejemplo:
"includeTTL" : true
ttlRelativeDate
-
Objetivo: especifique una fecha UTC con el formato AAAA-MM-DD hh:mm:ss utilizado para definir la caducidad de TTL de las filas de la tabla durante la importación a Oracle NoSQL Database.
Si una fila de tabla de los datos que está exportando ha caducado, puede definir el parámetro ttlRelativeDate en una fecha anterior a la hora de caducidad de la fila de tabla de los datos exportados.
Si no especifica este parámetro, se establece por defecto en la hora actual en milisegundos, obtenida de System.currentTimeMillis(), del equipo en el que se ejecuta la herramienta NoSQL Database Migrator.
- Tipo de datos: fecha
- Obligatorio (S/N): N
- Ejemplo:
"ttlRelativeDate" : "2021-01-03 04:31:17"
Consideremos un escenario en el que las filas de la tabla caducan después de siete días a partir del 1 de enero de 2021. Después de exportar esta tabla, el 7 de enero de 2021, se produce un problema con la tabla y decide importar los datos. Las filas de la tabla caducarán en un día (la fecha de caducidad de los datos menos el valor por defecto del parámetro de configuración ttlRelativedate, que es la fecha actual). Sin embargo, si desea ampliar la fecha de caducidad de las filas de la tabla a cinco días en lugar de a un día, utilice el parámetro ttlRelativeDate y elija una fecha anterior. Por lo tanto, en este escenario si desea ampliar el tiempo de caducidad de las filas de la tabla en cinco días, defina el valor de los parámetros de configuración ttlRelativeDate en 3-Ene-2021, que se utiliza como Hora de referencia cuando se importan las filas de la tabla.