deephaven.ImportTools.JsonImport¶
Tools for programmatically executing JSON batch imports.
-
class
JsonImportBuilder(*args, **kwargs)¶ -
build()¶ Creates a JsonImport object using the properties that have been set in the JsonImport.Builder.
- Returns
(com.illumon.iris.importers.util.JsonImport) A JsonImport object.
-
property
builder¶ The java builder object.
-
setColumnNames(columnNames)¶ Sets column names.
- Overload 1
- param columnNames
java.lang.String
- return
(com.illumon.iris.importers.util.JsonImport.Builder) this builder.
- Overload 2
- param columnNames
java.util.List<java.lang.String>
- return
(com.illumon.iris.importers.util.JsonImport.Builder) this builder.
-
setConstantColumnValue(constantColumnValue)¶ Sets the value to use for source columns with a sourceType of CONSTANT.
- Parameters
constantColumnValue – java.lang.String
- Returns
(com.illumon.iris.importers.util.JsonImport.Builder) this builder.
-
setDestinationDirectory(destinationDirectory)¶ Sets the destination directory.
- Parameters
destinationDirectory – (java.io.File) - destination directory.
- Returns
(ImportBuilder.T) this builder.
-
setDestinationPartitions(destinationPartitions)¶ Sets the destination partitions
- Overload 1
- param destinationPartitions
(java.lang.String) - destination partitions.
- return
(ImportBuilder.T) this builder.
- Overload 2
- param destinationPartitions
(java.lang.String[]) - destination partitions.
- return
(ImportBuilder.T) this builder.
-
setFieldPathSeparator(fieldPathSeparator)¶ Sets a String to use as the separator when generating column names from nested JSON data.
- Parameters
fieldPathSeparator – java.lang.String
- Returns
(com.illumon.iris.importers.util.JsonImport.Builder) this builder.
-
setMaxInferItems(maxInferItems)¶ - Sets a limit of the maximum number of JSON objects to examine when inferring which columns are present
in the file. Inference is necessary because JSON has no internal “schema”.
- Parameters
maxInferItems – long
- Returns
(com.illumon.iris.importers.util.JsonImport.Builder) this builder.
-
setOutputMode(outputMode)¶ Sets the output mode.
- Overload 1
- param outputMode
(com.illumon.iris.importers.ImportOutputMode) - output mode.
- return
(ImportBuilder.T) this builder.
- Overload 2
- param outputMode
(java.lang.String) - output mode.
- return
(ImportBuilder.T) this builder.
-
setPartitionColumn(partitionColumn)¶ Sets the partition column.
- Parameters
partitionColumn – (java.lang.String) - partition column.
- Returns
(ImportBuilder.T) this builder.
-
setSchemaService(schemaService)¶ Sets the schema service.
- Parameters
schemaService – (com.illumon.iris.db.schema.SchemaService) - schema service.
- Returns
(ImportBuilder.T) this builder.
-
setSourceDirectory(sourceDirectory)¶ Sets the source directory.
- Overload 1
- param sourceDirectory
(java.io.File) - source directory
- return
(FileImportBuilder.T) this builder
- Overload 2
- param sourceDirectory
(java.lang.String) - source directory
- return
(FileImportBuilder.T) this builder
-
setSourceFile(sourceFile)¶ Sets the source file.
- Parameters
sourceFile – (java.lang.String) - source file
- Returns
(FileImportBuilder.T) this builder
-
setSourceGlob(sourceGlob)¶ Sets the source glob.
- Parameters
sourceGlob – (java.lang.String) - source glob
- Returns
(FileImportBuilder.T) this builer
-
setSourceName(sourceName)¶ Sets the source name.
- Parameters
sourceName – (java.lang.String) - source name.
- Returns
(ImportBuilder.T) this builder.
-
setStrict(strict)¶ Sets strict checking.
- Parameters
strict – (boolean) - strict.
- Returns
(ImportBuilder.T) this builder.
-
-
builder(namespace, table)¶ - Creates a new JsonImportBuilder object. Method calls on this object can then be used to configure
the import and run it.
- Parameters
namespace – (java.lang.String) - The String name of the namespace into which data will be imported.
table – (java.lang.String) - The String name of the table into which data will be imported.
- Returns
(com.illumon.iris.importers.util.JsonImportBuilder) A new JsonImportBuilder object.