deephaven.ImportTools.DownsampleImport¶
Easy to use wrapper for downsampling data.
-
class
DownsampleImportBuilder
(*args, **kwargs)¶ -
addAggregate
(aggType, column)¶ Adds a combo aggregate method.
- Parameters
aggType – com.illumon.iris.db.v2.by.AggType
column – java.lang.String
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
addAggregates
(*aggregates)¶ Adds combo aggregate methods.
- Parameters
aggregates – com.illumon.iris.db.v2.by.ComboAggregateFactory.ComboBy…
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
addArrayColumns
(*columns)¶ Adds columns to compute array values for bins.
- Parameters
columns – java.lang.String…
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
addAvgColumns
(*columns)¶ Adds columns to compute the average values for bins.
- Parameters
columns – java.lang.String…
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
addFirstColumns
(*columns)¶ Adds columns to compute the first values for bins.
- Parameters
columns – java.lang.String…
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
addLastColumns
(*columns)¶ Adds columns to compute the last values for bins.
- Parameters
columns – java.lang.String…
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
addMaxColumns
(*columns)¶ Adds columns to compute the max values for bins.
- Parameters
columns – java.lang.String…
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
addMinColumns
(*columns)¶ Adds columns to compute the min values for bins.
- Parameters
columns – java.lang.String…
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
addStdColumns
(*columns)¶ Adds columns to compute the standard deviation values for bins.
- Parameters
columns – java.lang.String…
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
addSumColumns
(*columns)¶ Adds columns to compute the sum values for bins.
- Parameters
columns – java.lang.String…
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
addVarColumns
(*columns)¶ Adds columns to compute the variance values for bins.
- Parameters
columns – java.lang.String…
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
build
()¶ Builds the importer.
- Returns
(com.illumon.iris.importers.util.DownsampleImport) importer.
-
property
builder
¶ The java builder object.
-
setAJStrategy
(ajStrategy)¶ Sets the as-of-join strategy.
- Overload 1
- param ajStrategy
java.lang.String
- return
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
- Overload 2
- param ajStrategy
com.illumon.iris.db.tables.Table.JoinStrategy
- return
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
setAllBins
(allBins)¶ Sets whether data will be output for all bins, even if there are no samples.
- Parameters
allBins – boolean
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
setByStrategy
(byStrategy)¶ Sets the by strategy.
- Overload 1
- param byStrategy
com.illumon.iris.db.tables.Table.ByStrategy
- return
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
- Overload 2
- param byStrategy
java.lang.String
- return
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
setCalendar
(calendar)¶ Sets the calendar.
- Parameters
calendar – java.lang.String
- Returns
(com.illumon.iris.importers.util.DownsampleImport.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.
-
setLogger
(logger)¶ Sets the logger.
- Parameters
logger – com.fishlib.io.logger.Logger
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
setMaintainStateColumns
(*maintainStateColumns)¶ Adds columns to keep via as-of-join.
- Parameters
maintainStateColumns – java.lang.String…
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
setNaturalJoinStrategy
(naturalJoinStrategy)¶ Sets the natural join strategy.
- Overload 1
- param naturalJoinStrategy
com.illumon.iris.db.tables.Table.JoinStrategy
- return
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
- Overload 2
- param naturalJoinStrategy
java.lang.String
- return
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
setNumThreads
(numThreads)¶ Sets the number of threads.
- Parameters
numThreads – int
- Returns
(com.illumon.iris.importers.util.DownsampleImport.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
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
setSchemaService
(schemaService)¶ Sets the schema service.
- Parameters
schemaService – (com.illumon.iris.db.schema.SchemaService) - schema service.
- Returns
(ImportBuilder.T) this builder.
-
setSourceName
(sourceName)¶ Sets the source name.
- Parameters
sourceName – (java.lang.String) - source name.
- Returns
(ImportBuilder.T) this builder.
-
setSourceTable
(sourceTable)¶ Sets the source table.
- Parameters
sourceTable – com.illumon.iris.db.tables.Table
- Returns
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
setStrict
(strict)¶ Sets strict checking.
- Parameters
strict – (boolean) - strict.
- Returns
(ImportBuilder.T) this builder.
-
setTimeBinMode
(timeBinMode)¶ Sets the time bin mode.
- Overload 1
- param timeBinMode
com.illumon.iris.downsampling.Downsampler.TimeBinMode
- return
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
- Overload 2
- param timeBinMode
java.lang.String
- return
(com.illumon.iris.importers.util.DownsampleImport.Builder) this builder.
-
-
builder
(db, namespace, table, timestampColumn, period, *keyColumns)¶ - Creates a new DownsampleImportBuilder object. Method calls on this object can then be used to configure
the import and run it.
- Parameters
db – (com.illumon.iris.db.tables.databases.Database) - database.
namespace – (java.lang.String) - namespace into which data will be imported.
table – (java.lang.String) - name of the table into which data will be imported.
timestampColumn – (java.lang.String) - timestamp column.
period – (java.lang.String) - downsample period.
keyColumns – (java.lang.String…) - key columns.
- Returns
(com.illumon.iris.importers.util.DownsampleImportBuilder) A new DownsampleImportBuilder object.