Skip to content

InfluxDBv3EnterpriseParameters

Source code in docs_src/capo_timestream_influxdb/types/influx_d_bv3_enterprise_parameters.py
class InfluxDBv3EnterpriseParameters(TypedDict, closed=True):
    query_file_limit: NotRequired["int"]
    """<p>Limits the number of Parquet files a query can access. If a query attempts to read more than this limit, InfluxDB 3 returns an error.</p> <p>Default: 432</p>"""
    query_log_size: NotRequired["int"]
    """<p>Defines the size of the query log. Up to this many queries remain in the log before older queries are evicted to make room for new ones.</p> <p>Default: 1000</p>"""
    log_filter: NotRequired["str"]
    """<p>Sets the filter directive for logs.</p>"""
    log_format: NotRequired["capo_timestream_influxdb.types.log_formats.LogFormats"]
    """<p>Defines the message format for logs.</p> <p>Default: full</p>"""
    data_fusion_num_threads: NotRequired["int"]
    """<p>Sets the maximum number of DataFusion runtime threads to use.</p>"""
    data_fusion_runtime_type: NotRequired[
        "capo_timestream_influxdb.types.data_fusion_runtime_type.DataFusionRuntimeType"
    ]
    """<p>Specifies the DataFusion tokio runtime type.</p> <p>Default: multi-thread</p>"""
    data_fusion_runtime_disable_lifo_slot: NotRequired["bool"]
    """<p>Disables the LIFO slot of the DataFusion runtime.</p>"""
    data_fusion_runtime_event_interval: NotRequired["int"]
    """<p>Sets the number of scheduler ticks after which the scheduler of the DataFusion tokio runtime polls for external events–for example: timers, I/O.</p>"""
    data_fusion_runtime_global_queue_interval: NotRequired["int"]
    """<p>Sets the number of scheduler ticks after which the scheduler of the DataFusion runtime polls the global task queue.</p>"""
    data_fusion_runtime_max_blocking_threads: NotRequired["int"]
    """<p>Specifies the limit for additional threads spawned by the DataFusion runtime.</p>"""
    data_fusion_runtime_max_io_events_per_tick: NotRequired["int"]
    """<p>Configures the maximum number of events processed per tick by the tokio DataFusion runtime.</p>"""
    data_fusion_runtime_thread_keep_alive: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion runtime.</p>"""
    data_fusion_runtime_thread_priority: NotRequired["int"]
    """<p>Sets the thread priority for tokio DataFusion runtime workers.</p> <p>Default: 10</p>"""
    data_fusion_max_parquet_fanout: NotRequired["int"]
    """<p>When multiple parquet files are required in a sorted way (deduplication for example), specifies the maximum fanout.</p> <p>Default: 1000</p>"""
    data_fusion_use_cached_parquet_loader: NotRequired["bool"]
    """<p>Uses a cached parquet loader when reading parquet files from the object store.</p>"""
    data_fusion_config: NotRequired["str"]
    """<p>Provides custom configuration to DataFusion as a comma-separated list of key:value pairs.</p>"""
    max_http_request_size: NotRequired["int"]
    """<p>Specifies the maximum size of HTTP requests.</p> <p>Default: 10485760</p>"""
    force_snapshot_mem_threshold: NotRequired[
        "capo_timestream_influxdb.types.percent_or_absolute_long.PercentOrAbsoluteLong"
    ]
    """<p>Specifies the threshold for the internal memory buffer. Supports either a percentage (portion of available memory) or absolute value in MB–for example: 70% or 100</p> <p>Default: 70%</p>"""
    wal_snapshot_size: NotRequired["int"]
    """<p>Defines the number of WAL files to attempt to remove in a snapshot. This, multiplied by the interval, determines how often snapshots are taken.</p> <p>Default: 600</p>"""
    wal_max_write_buffer_size: NotRequired["int"]
    """<p>Specifies the maximum number of write requests that can be buffered before a flush must be executed and succeed.</p> <p>Default: 100000</p>"""
    snapshotted_wal_files_to_keep: NotRequired["int"]
    """<p>Specifies the number of snapshotted WAL files to retain in the object store. Flushing the WAL files does not clear the WAL files immediately; they are deleted when the number of snapshotted WAL files exceeds this number.</p> <p>Default: 300</p>"""
    preemptive_cache_age: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>Specifies the interval to prefetch into the Parquet cache during compaction.</p> <p>Default: 3d</p>"""
    parquet_mem_cache_prune_percentage: NotRequired["float"]
    """<p>Specifies the percentage of entries to prune during a prune operation on the in-memory Parquet cache.</p> <p>Default: 0.1</p>"""
    parquet_mem_cache_prune_interval: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>Sets the interval to check if the in-memory Parquet cache needs to be pruned.</p> <p>Default: 1s</p>"""
    disable_parquet_mem_cache: NotRequired["bool"]
    """<p>Disables the in-memory Parquet cache. By default, the cache is enabled.</p>"""
    parquet_mem_cache_query_path_duration: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>Specifies the time window for caching recent Parquet files in memory.</p> <p>Default: 5h</p>"""
    last_cache_eviction_interval: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>Specifies the interval to evict expired entries from the Last-N-Value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.</p> <p>Default: 10s</p>"""
    distinct_cache_eviction_interval: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>Specifies the interval to evict expired entries from the distinct value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.</p> <p>Default: 10s</p>"""
    gen1_duration: NotRequired["capo_timestream_influxdb.types.duration.Duration"]
    """<p>Specifies the duration that Parquet files are arranged into. Data timestamps land each row into a file of this duration. Supported durations are 1m, 5m, and 10m. These files are known as “generation 1” files, which the compactor can merge into larger generations.</p> <p>Default: 10m</p>"""
    exec_mem_pool_bytes: NotRequired[
        "capo_timestream_influxdb.types.percent_or_absolute_long.PercentOrAbsoluteLong"
    ]
    """<p>Specifies the size of memory pool used during query execution. Can be given as absolute value in bytes or as a percentage of the total available memory–for example: 8000000000 or 10%.</p> <p>Default: 20%</p>"""
    parquet_mem_cache_size: NotRequired[
        "capo_timestream_influxdb.types.percent_or_absolute_long.PercentOrAbsoluteLong"
    ]
    """<p>Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory.</p> <p>Default: 20%</p>"""
    wal_replay_fail_on_error: NotRequired["bool"]
    """<p>Determines whether WAL replay should fail when encountering errors.</p> <p>Default: false</p>"""
    wal_replay_concurrency_limit: NotRequired["int"]
    """<p>Concurrency limit during WAL replay. Setting this number too high can lead to OOM. The default is dynamically determined.</p> <p>Default: max(num_cpus, 10)</p>"""
    table_index_cache_max_entries: NotRequired["int"]
    """<p>Specifies the maximum number of entries in the table index cache.</p> <p>Default: 1000</p>"""
    table_index_cache_concurrency_limit: NotRequired["int"]
    """<p>Limits the concurrency level for table index cache operations.</p> <p>Default: 8</p>"""
    gen1_lookback_duration: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>Specifies how far back to look when creating generation 1 Parquet files.</p> <p>Default: 24h</p>"""
    retention_check_interval: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>The interval at which retention policies are checked and enforced. Enter as a human-readable time–for example: 30m or 1h.</p> <p>Default: 30m</p>"""
    delete_grace_period: NotRequired["capo_timestream_influxdb.types.duration.Duration"]
    """<p>Specifies the grace period before permanently deleting data.</p> <p>Default: 24h</p>"""
    hard_delete_default_duration: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>Sets the default duration for hard deletion of data.</p> <p>Default: 90d</p>"""
    plugin_repository_url: NotRequired["str"]
    """<p>Specifies the URL of the repository that InfluxDB downloads plugins from.</p>"""
    plugin_repository_secret_arn: NotRequired[
        "capo_timestream_influxdb.types.plugin_repository_secret_arn.PluginRepositorySecretArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the Secrets Manager secret that holds your repository access token.</p>"""
    ingest_query_instances: "int"
    """<p>Specifies number of instances in the DbCluster which can both ingest and query.</p>"""
    query_only_instances: "int"
    """<p>Specifies number of instances in the DbCluster which can only query.</p>"""
    dedicated_compactor: "bool"
    """<p>Specifies if the compactor instance should be a standalone instance or not.</p>"""
    compaction_row_limit: NotRequired["int"]
    """<p>Specifies the soft limit for the number of rows per file that the compactor writes. The compactor may write more rows than this limit.</p> <p>Default: 1000000</p>"""
    compaction_max_num_files_per_plan: NotRequired["int"]
    """<p>Sets the maximum number of files included in any compaction plan.</p> <p>Default: 500</p>"""
    compaction_gen2_duration: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>Specifies the duration of the first level of compaction (gen2). Later levels of compaction are multiples of this duration. This value should be equal to or greater than the gen1 duration.</p> <p>Default: 20m</p>"""
    compaction_multipliers: NotRequired["str"]
    """<p>Specifies a comma-separated list of multiples defining the duration of each level of compaction. The number of elements in the list determines the number of compaction levels. The first element specifies the duration of the first level (gen3); subsequent levels are multiples of the previous level.</p> <p>Default: 3,4,6,5</p>"""
    compaction_cleanup_wait: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>Specifies the amount of time that the compactor waits after finishing a compaction run to delete files marked as needing deletion during that compaction run.</p> <p>Default: 10m</p>"""
    compaction_check_interval: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>Specifies how often the compactor checks for new compaction work to perform.</p> <p>Default: 10s</p>"""
    last_value_cache_disable_from_history: NotRequired["bool"]
    """<p>Disables populating the last-N-value cache from historical data. If disabled, the cache is still populated with data from the write-ahead log (WAL).</p>"""
    distinct_value_cache_disable_from_history: NotRequired["bool"]
    """<p>Disables populating the distinct value cache from historical data. If disabled, the cache is still populated with data from the write-ahead log (WAL).</p>"""
    replication_interval: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>Specifies the interval at which data replication occurs between cluster nodes.</p> <p>Default: 250ms</p>"""
    catalog_sync_interval: NotRequired[
        "capo_timestream_influxdb.types.duration.Duration"
    ]
    """<p>Defines how often the catalog synchronizes across cluster nodes.</p> <p>Default: 10s</p>"""

catalog_sync_interval instance-attribute

catalog_sync_interval: NotRequired[Duration]

Defines how often the catalog synchronizes across cluster nodes.

Default: 10s

compaction_check_interval instance-attribute

compaction_check_interval: NotRequired[Duration]

Specifies how often the compactor checks for new compaction work to perform.

Default: 10s

compaction_cleanup_wait instance-attribute

compaction_cleanup_wait: NotRequired[Duration]

Specifies the amount of time that the compactor waits after finishing a compaction run to delete files marked as needing deletion during that compaction run.

Default: 10m

compaction_gen2_duration instance-attribute

compaction_gen2_duration: NotRequired[Duration]

Specifies the duration of the first level of compaction (gen2). Later levels of compaction are multiples of this duration. This value should be equal to or greater than the gen1 duration.

Default: 20m

compaction_max_num_files_per_plan instance-attribute

compaction_max_num_files_per_plan: NotRequired[int]

Sets the maximum number of files included in any compaction plan.

Default: 500

compaction_multipliers instance-attribute

compaction_multipliers: NotRequired[str]

Specifies a comma-separated list of multiples defining the duration of each level of compaction. The number of elements in the list determines the number of compaction levels. The first element specifies the duration of the first level (gen3); subsequent levels are multiples of the previous level.

Default: 3,4,6,5

compaction_row_limit instance-attribute

compaction_row_limit: NotRequired[int]

Specifies the soft limit for the number of rows per file that the compactor writes. The compactor may write more rows than this limit.

Default: 1000000

data_fusion_config instance-attribute

data_fusion_config: NotRequired[str]

Provides custom configuration to DataFusion as a comma-separated list of key:value pairs.

data_fusion_max_parquet_fanout instance-attribute

data_fusion_max_parquet_fanout: NotRequired[int]

When multiple parquet files are required in a sorted way (deduplication for example), specifies the maximum fanout.

Default: 1000

data_fusion_num_threads instance-attribute

data_fusion_num_threads: NotRequired[int]

Sets the maximum number of DataFusion runtime threads to use.

data_fusion_runtime_disable_lifo_slot instance-attribute

data_fusion_runtime_disable_lifo_slot: NotRequired[bool]

Disables the LIFO slot of the DataFusion runtime.

data_fusion_runtime_event_interval instance-attribute

data_fusion_runtime_event_interval: NotRequired[int]

Sets the number of scheduler ticks after which the scheduler of the DataFusion tokio runtime polls for external events–for example: timers, I/O.

data_fusion_runtime_global_queue_interval instance-attribute

data_fusion_runtime_global_queue_interval: NotRequired[int]

Sets the number of scheduler ticks after which the scheduler of the DataFusion runtime polls the global task queue.

data_fusion_runtime_max_blocking_threads instance-attribute

data_fusion_runtime_max_blocking_threads: NotRequired[int]

Specifies the limit for additional threads spawned by the DataFusion runtime.

data_fusion_runtime_max_io_events_per_tick instance-attribute

data_fusion_runtime_max_io_events_per_tick: NotRequired[int]

Configures the maximum number of events processed per tick by the tokio DataFusion runtime.

data_fusion_runtime_thread_keep_alive instance-attribute

data_fusion_runtime_thread_keep_alive: NotRequired[Duration]

Sets a custom timeout for a thread in the blocking pool of the tokio DataFusion runtime.

data_fusion_runtime_thread_priority instance-attribute

data_fusion_runtime_thread_priority: NotRequired[int]

Sets the thread priority for tokio DataFusion runtime workers.

Default: 10

data_fusion_runtime_type instance-attribute

data_fusion_runtime_type: NotRequired[DataFusionRuntimeType]

Specifies the DataFusion tokio runtime type.

Default: multi-thread

data_fusion_use_cached_parquet_loader instance-attribute

data_fusion_use_cached_parquet_loader: NotRequired[bool]

Uses a cached parquet loader when reading parquet files from the object store.

dedicated_compactor instance-attribute

dedicated_compactor: bool

Specifies if the compactor instance should be a standalone instance or not.

delete_grace_period instance-attribute

delete_grace_period: NotRequired[Duration]

Specifies the grace period before permanently deleting data.

Default: 24h

disable_parquet_mem_cache instance-attribute

disable_parquet_mem_cache: NotRequired[bool]

Disables the in-memory Parquet cache. By default, the cache is enabled.

distinct_cache_eviction_interval instance-attribute

distinct_cache_eviction_interval: NotRequired[Duration]

Specifies the interval to evict expired entries from the distinct value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

Default: 10s

distinct_value_cache_disable_from_history instance-attribute

distinct_value_cache_disable_from_history: NotRequired[bool]

Disables populating the distinct value cache from historical data. If disabled, the cache is still populated with data from the write-ahead log (WAL).

exec_mem_pool_bytes instance-attribute

exec_mem_pool_bytes: NotRequired[PercentOrAbsoluteLong]

Specifies the size of memory pool used during query execution. Can be given as absolute value in bytes or as a percentage of the total available memory–for example: 8000000000 or 10%.

Default: 20%

force_snapshot_mem_threshold instance-attribute

force_snapshot_mem_threshold: NotRequired[PercentOrAbsoluteLong]

Specifies the threshold for the internal memory buffer. Supports either a percentage (portion of available memory) or absolute value in MB–for example: 70% or 100

Default: 70%

gen1_duration instance-attribute

gen1_duration: NotRequired[Duration]

Specifies the duration that Parquet files are arranged into. Data timestamps land each row into a file of this duration. Supported durations are 1m, 5m, and 10m. These files are known as “generation 1” files, which the compactor can merge into larger generations.

Default: 10m

gen1_lookback_duration instance-attribute

gen1_lookback_duration: NotRequired[Duration]

Specifies how far back to look when creating generation 1 Parquet files.

Default: 24h

hard_delete_default_duration instance-attribute

hard_delete_default_duration: NotRequired[Duration]

Sets the default duration for hard deletion of data.

Default: 90d

ingest_query_instances instance-attribute

ingest_query_instances: int

Specifies number of instances in the DbCluster which can both ingest and query.

last_cache_eviction_interval instance-attribute

last_cache_eviction_interval: NotRequired[Duration]

Specifies the interval to evict expired entries from the Last-N-Value cache, expressed as a human-readable duration–for example: 20s, 1m, 1h.

Default: 10s

last_value_cache_disable_from_history instance-attribute

last_value_cache_disable_from_history: NotRequired[bool]

Disables populating the last-N-value cache from historical data. If disabled, the cache is still populated with data from the write-ahead log (WAL).

log_filter instance-attribute

log_filter: NotRequired[str]

Sets the filter directive for logs.

log_format instance-attribute

log_format: NotRequired[LogFormats]

Defines the message format for logs.

Default: full

max_http_request_size instance-attribute

max_http_request_size: NotRequired[int]

Specifies the maximum size of HTTP requests.

Default: 10485760

parquet_mem_cache_prune_interval instance-attribute

parquet_mem_cache_prune_interval: NotRequired[Duration]

Sets the interval to check if the in-memory Parquet cache needs to be pruned.

Default: 1s

parquet_mem_cache_prune_percentage instance-attribute

parquet_mem_cache_prune_percentage: NotRequired[float]

Specifies the percentage of entries to prune during a prune operation on the in-memory Parquet cache.

Default: 0.1

parquet_mem_cache_query_path_duration instance-attribute

parquet_mem_cache_query_path_duration: NotRequired[Duration]

Specifies the time window for caching recent Parquet files in memory.

Default: 5h

parquet_mem_cache_size instance-attribute

parquet_mem_cache_size: NotRequired[PercentOrAbsoluteLong]

Specifies the size of the in-memory Parquet cache in megabytes or percentage of total available memory.

Default: 20%

plugin_repository_secret_arn instance-attribute

plugin_repository_secret_arn: NotRequired[PluginRepositorySecretArn]

The Amazon Resource Name (ARN) of the Secrets Manager secret that holds your repository access token.

plugin_repository_url instance-attribute

plugin_repository_url: NotRequired[str]

Specifies the URL of the repository that InfluxDB downloads plugins from.

preemptive_cache_age instance-attribute

preemptive_cache_age: NotRequired[Duration]

Specifies the interval to prefetch into the Parquet cache during compaction.

Default: 3d

query_file_limit instance-attribute

query_file_limit: NotRequired[int]

Limits the number of Parquet files a query can access. If a query attempts to read more than this limit, InfluxDB 3 returns an error.

Default: 432

query_log_size instance-attribute

query_log_size: NotRequired[int]

Defines the size of the query log. Up to this many queries remain in the log before older queries are evicted to make room for new ones.

Default: 1000

query_only_instances instance-attribute

query_only_instances: int

Specifies number of instances in the DbCluster which can only query.

replication_interval instance-attribute

replication_interval: NotRequired[Duration]

Specifies the interval at which data replication occurs between cluster nodes.

Default: 250ms

retention_check_interval instance-attribute

retention_check_interval: NotRequired[Duration]

The interval at which retention policies are checked and enforced. Enter as a human-readable time–for example: 30m or 1h.

Default: 30m

snapshotted_wal_files_to_keep instance-attribute

snapshotted_wal_files_to_keep: NotRequired[int]

Specifies the number of snapshotted WAL files to retain in the object store. Flushing the WAL files does not clear the WAL files immediately; they are deleted when the number of snapshotted WAL files exceeds this number.

Default: 300

table_index_cache_concurrency_limit instance-attribute

table_index_cache_concurrency_limit: NotRequired[int]

Limits the concurrency level for table index cache operations.

Default: 8

table_index_cache_max_entries instance-attribute

table_index_cache_max_entries: NotRequired[int]

Specifies the maximum number of entries in the table index cache.

Default: 1000

wal_max_write_buffer_size instance-attribute

wal_max_write_buffer_size: NotRequired[int]

Specifies the maximum number of write requests that can be buffered before a flush must be executed and succeed.

Default: 100000

wal_replay_concurrency_limit instance-attribute

wal_replay_concurrency_limit: NotRequired[int]

Concurrency limit during WAL replay. Setting this number too high can lead to OOM. The default is dynamically determined.

Default: max(num_cpus, 10)

wal_replay_fail_on_error instance-attribute

wal_replay_fail_on_error: NotRequired[bool]

Determines whether WAL replay should fail when encountering errors.

Default: false

wal_snapshot_size instance-attribute

wal_snapshot_size: NotRequired[int]

Defines the number of WAL files to attempt to remove in a snapshot. This, multiplied by the interval, determines how often snapshots are taken.

Default: 600