public class AlterSystemPropertiesRequest extends Object implements org.apache.avro.generic.IndexedRecord
GPUdb.alterSystemProperties
.
The GPUdb.alterSystemProperties
endpoint is primarily used to simplify the
testing of the system and is not expected to be used during normal
execution. Commands are given through the propertyUpdatesMap
whose keys are commands and values are strings
representing integer values (for example '8000') or boolean values ('true'
or 'false').
Modifier and Type | Class and Description |
---|---|
static class |
AlterSystemPropertiesRequest.Options
A set of string constants for the
AlterSystemPropertiesRequest
parameter options . |
static class |
AlterSystemPropertiesRequest.PropertyUpdatesMap
A set of string constants for the
AlterSystemPropertiesRequest
parameter propertyUpdatesMap . |
Constructor and Description |
---|
AlterSystemPropertiesRequest()
Constructs an AlterSystemPropertiesRequest object with default
parameters.
|
AlterSystemPropertiesRequest(Map<String,String> propertyUpdatesMap,
Map<String,String> options)
Constructs an AlterSystemPropertiesRequest object with the specified
parameters.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
Object |
get(int index)
This method supports the Avro framework and is not intended to be called
directly by the user.
|
static org.apache.avro.Schema |
getClassSchema()
This method supports the Avro framework and is not intended to be called
directly by the user.
|
Map<String,String> |
getOptions()
Optional parameters.
|
Map<String,String> |
getPropertyUpdatesMap()
Map containing the properties of the system to be updated.
|
org.apache.avro.Schema |
getSchema()
This method supports the Avro framework and is not intended to be called
directly by the user.
|
int |
hashCode() |
void |
put(int index,
Object value)
This method supports the Avro framework and is not intended to be called
directly by the user.
|
AlterSystemPropertiesRequest |
setOptions(Map<String,String> options)
Optional parameters.
|
AlterSystemPropertiesRequest |
setPropertyUpdatesMap(Map<String,String> propertyUpdatesMap)
Map containing the properties of the system to be updated.
|
String |
toString() |
public AlterSystemPropertiesRequest()
public AlterSystemPropertiesRequest(Map<String,String> propertyUpdatesMap, Map<String,String> options)
propertyUpdatesMap
- Map containing the properties of the system
to be updated. Error if empty.
CONCURRENT_KERNEL_EXECUTION
: Enables
concurrent kernel execution if the
value is TRUE
and
disables it if the value is FALSE
.
Supported values:
SUBTASK_CONCURRENCY_LIMIT
: Sets the
maximum number of simultaneous
threads allocated to a given request,
on each rank. Note that thread
allocation may also be limited by
resource group limits and/or system
load.
CHUNK_SIZE
: Sets the number of
records per chunk to be used for all
new tables.
CHUNK_COLUMN_MAX_MEMORY
: Sets the
target maximum data size for each
column in a chunk to be used for all
new tables.
CHUNK_MAX_MEMORY
: Indicates the
target maximum data size for all
columns in a chunk to be used for all
new tables.
EXECUTION_MODE
: Sets the
execution_mode for kernel executions
to the specified string value.
Possible values are host, device,
default (engine decides) or an
integer value that indicates max
chunk size to exec on host
EXTERNAL_FILES_DIRECTORY
: Sets the
root directory path where external
table data files are accessed from.
Path must exist on the head node
REQUEST_TIMEOUT
: Number of minutes
after which filtering (e.g., GPUdb.filter
) and aggregating (e.g.,
GPUdb.aggregateGroupBy
) queries will
timeout. The default value is '20'.
The minimum allowed value is '0'. The
maximum allowed value is '1440'.
MAX_GET_RECORDS_SIZE
: The maximum
number of records the database will
serve for a given data retrieval
call. The default value is '20000'.
The minimum allowed value is '0'. The
maximum allowed value is '1000000'.
ENABLE_AUDIT
: Enable or disable
auditing.
AUDIT_HEADERS
: Enable or disable
auditing of request headers.
AUDIT_BODY
: Enable or disable
auditing of request bodies.
AUDIT_DATA
: Enable or disable
auditing of request data.
AUDIT_RESPONSE
: Enable or disable
auditing of response information.
SHADOW_AGG_SIZE
: Size of the shadow
aggregate chunk cache in bytes. The
default value is '10000000'. The
minimum allowed value is '0'. The
maximum allowed value is
'2147483647'.
SHADOW_FILTER_SIZE
: Size of the
shadow filter chunk cache in bytes.
The default value is '10000000'. The
minimum allowed value is '0'. The
maximum allowed value is
'2147483647'.
ENABLE_OVERLAPPED_EQUI_JOIN
: Enable
overlapped-equi-join filter. The
default value is 'true'.
ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN
:
Enable the one_step
compound-equi-join algorithm. The
default value is 'true'.
KAFKA_BATCH_SIZE
: Maximum number of
records to be ingested in a single
batch. The default value is '1000'.
The minimum allowed value is '1'. The
maximum allowed value is '10000000'.
KAFKA_POLL_TIMEOUT
: Maximum time
(milliseconds) for each poll to get
records from kafka. The default value
is '0'. The minimum allowed value is
'0'. The maximum allowed value is
'1000'.
KAFKA_WAIT_TIME
: Maximum time
(seconds) to buffer records received
from kafka before ingestion. The
default value is '30'. The minimum
allowed value is '1'. The maximum
allowed value is '120'.
EGRESS_PARQUET_COMPRESSION
: Parquet
file compression type.
Supported values:
The default value is SNAPPY
.
EGRESS_SINGLE_FILE_MAX_SIZE
: Max
file size (in MB) to allow saving to
a single file. May be overridden by
target limitations. The default value
is '10000'. The minimum allowed value
is '1'. The maximum allowed value is
'200000'.
MAX_CONCURRENT_KERNELS
: Sets the
max_concurrent_kernels value of the
conf. The minimum allowed value is
'0'. The maximum allowed value is
'256'.
SYSTEM_METADATA_RETENTION_PERIOD
:
Sets the
system_metadata.retention_period
value of the conf. The minimum
allowed value is '1'.
TCS_PER_TOM
: Size of the worker rank
data calculation thread pool. This
is primarily used for
computation-based operations such as
aggregates and record retrieval. The
minimum allowed value is '2'. The
maximum allowed value is '8192'.
TPS_PER_TOM
: Size of the worker rank
data processing thread pool. This
includes operations such as inserts,
updates, & deletes on table data.
Multi-head inserts are not affected
by this limit. The minimum allowed
value is '2'. The maximum allowed
value is '8192'.
BACKGROUND_WORKER_THREADS
: Size of
the worker rank background thread
pool. This includes background
operations such as watermark
evictions catalog table updates. The
minimum allowed value is '1'. The
maximum allowed value is '8192'.
LOG_DEBUG_JOB_INFO
: Outputs various
job-related information to the rank
logs. Used for troubleshooting.
ENABLE_THREAD_HANG_LOGGING
: Log a
stack trace for any thread that runs
longer than a defined threshold. Used
for troubleshooting. The default
value is 'true'.
AI_ENABLE_RAG
: Enable RAG. The
default value is 'false'.
AI_API_PROVIDER
: AI API provider
type
AI_API_URL
: AI API URL
AI_API_KEY
: AI API key
AI_API_CONNECTION_TIMEOUT
: AI API
connection timeout in seconds
AI_API_EMBEDDINGS_MODEL
: AI API
model name
TELM_PERSIST_QUERY_METRICS
: Enable
or disable persisting of query
metrics.
POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT
:
Idle connection timeout in seconds
POSTGRES_PROXY_KEEP_ALIVE
: Enable
postgres proxy keep alive. The
default value is 'false'.
KIFS_DIRECTORY_DATA_LIMIT
: The
default maximum capacity to apply
when creating a KiFS directory
(bytes). The minimum allowed value is
'-1'.
COMPRESSION_CODEC
: The default compression
algorithm applied to any column
without a column-level or table-level
default compression specified at the
time it was created
DISK_AUTO_OPTIMIZE_TIMEOUT
: Time
interval in seconds after which the
database will apply
optimizations/transformations to
persisted data, such as compression.
The minimum allowed value is '0'.
HA_CONSUMER_REPLAY_OFFSET
:
Initializes HA replay from the given
timestamp (as milliseconds since unix
epoch). The minimum allowed value is
'-1'.
options
- Optional parameters.
EVICT_TO_COLD
: If
TRUE
and evict_columns is
specified, the given objects will be evicted to
cold storage (if such a tier exists).
Supported values:
PERSIST
: If TRUE
the system configuration will
be written to disk upon successful application
of this request. This will commit the changes
from this request and any additional in-memory
modifications.
Supported values:
The default value is TRUE
.
Map
.public static org.apache.avro.Schema getClassSchema()
public Map<String,String> getPropertyUpdatesMap()
CONCURRENT_KERNEL_EXECUTION
: Enables concurrent kernel
execution if the value is TRUE
and disables it if the value is FALSE
.
Supported values:
SUBTASK_CONCURRENCY_LIMIT
: Sets the maximum number of
simultaneous threads allocated to a given request, on each rank.
Note that thread allocation may also be limited by resource
group limits and/or system load.
CHUNK_SIZE
: Sets the
number of records per chunk to be used for all new tables.
CHUNK_COLUMN_MAX_MEMORY
: Sets the target maximum data size for
each column in a chunk to be used for all new tables.
CHUNK_MAX_MEMORY
:
Indicates the target maximum data size for all columns in a
chunk to be used for all new tables.
EXECUTION_MODE
: Sets
the execution_mode for kernel executions to the specified string
value. Possible values are host, device, default (engine
decides) or an integer value that indicates max chunk size to
exec on host
EXTERNAL_FILES_DIRECTORY
: Sets the root directory path where
external table data files are accessed from. Path must exist on
the head node
REQUEST_TIMEOUT
:
Number of minutes after which filtering (e.g., GPUdb.filter
) and
aggregating (e.g., GPUdb.aggregateGroupBy
) queries will timeout. The default value
is '20'. The minimum allowed value is '0'. The maximum allowed
value is '1440'.
MAX_GET_RECORDS_SIZE
: The maximum number of records the
database will serve for a given data retrieval call. The default
value is '20000'. The minimum allowed value is '0'. The maximum
allowed value is '1000000'.
ENABLE_AUDIT
: Enable or
disable auditing.
AUDIT_HEADERS
: Enable
or disable auditing of request headers.
AUDIT_BODY
: Enable or
disable auditing of request bodies.
AUDIT_DATA
: Enable or
disable auditing of request data.
AUDIT_RESPONSE
: Enable
or disable auditing of response information.
SHADOW_AGG_SIZE
: Size
of the shadow aggregate chunk cache in bytes. The default value
is '10000000'. The minimum allowed value is '0'. The maximum
allowed value is '2147483647'.
SHADOW_FILTER_SIZE
: Size of the shadow filter chunk cache in
bytes. The default value is '10000000'. The minimum allowed
value is '0'. The maximum allowed value is '2147483647'.
ENABLE_OVERLAPPED_EQUI_JOIN
: Enable overlapped-equi-join
filter. The default value is 'true'.
ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN
: Enable the one_step
compound-equi-join algorithm. The default value is 'true'.
KAFKA_BATCH_SIZE
:
Maximum number of records to be ingested in a single batch. The
default value is '1000'. The minimum allowed value is '1'. The
maximum allowed value is '10000000'.
KAFKA_POLL_TIMEOUT
: Maximum time (milliseconds) for each poll
to get records from kafka. The default value is '0'. The minimum
allowed value is '0'. The maximum allowed value is '1000'.
KAFKA_WAIT_TIME
:
Maximum time (seconds) to buffer records received from kafka
before ingestion. The default value is '30'. The minimum allowed
value is '1'. The maximum allowed value is '120'.
EGRESS_PARQUET_COMPRESSION
: Parquet file compression type.
Supported values:
The default value is SNAPPY
.
EGRESS_SINGLE_FILE_MAX_SIZE
: Max file size (in MB) to allow
saving to a single file. May be overridden by target
limitations. The default value is '10000'. The minimum allowed
value is '1'. The maximum allowed value is '200000'.
MAX_CONCURRENT_KERNELS
: Sets the max_concurrent_kernels value
of the conf. The minimum allowed value is '0'. The maximum
allowed value is '256'.
SYSTEM_METADATA_RETENTION_PERIOD
: Sets the
system_metadata.retention_period value of the conf. The minimum
allowed value is '1'.
TCS_PER_TOM
: Size of the
worker rank data calculation thread pool. This is primarily
used for computation-based operations such as aggregates and
record retrieval. The minimum allowed value is '2'. The maximum
allowed value is '8192'.
TPS_PER_TOM
: Size of the
worker rank data processing thread pool. This includes
operations such as inserts, updates, & deletes on table data.
Multi-head inserts are not affected by this limit. The minimum
allowed value is '2'. The maximum allowed value is '8192'.
BACKGROUND_WORKER_THREADS
: Size of the worker rank background
thread pool. This includes background operations such as
watermark evictions catalog table updates. The minimum allowed
value is '1'. The maximum allowed value is '8192'.
LOG_DEBUG_JOB_INFO
: Outputs various job-related information to
the rank logs. Used for troubleshooting.
ENABLE_THREAD_HANG_LOGGING
: Log a stack trace for any thread
that runs longer than a defined threshold. Used for
troubleshooting. The default value is 'true'.
AI_ENABLE_RAG
: Enable
RAG. The default value is 'false'.
AI_API_PROVIDER
: AI
API provider type
AI_API_URL
: AI API URL
AI_API_KEY
: AI API key
AI_API_CONNECTION_TIMEOUT
: AI API connection timeout in seconds
AI_API_EMBEDDINGS_MODEL
: AI API model name
TELM_PERSIST_QUERY_METRICS
: Enable or disable persisting of
query metrics.
POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT
: Idle connection timeout
in seconds
POSTGRES_PROXY_KEEP_ALIVE
: Enable postgres proxy keep alive.
The default value is 'false'.
KIFS_DIRECTORY_DATA_LIMIT
: The default maximum capacity to
apply when creating a KiFS directory (bytes). The minimum
allowed value is '-1'.
COMPRESSION_CODEC
:
The default compression algorithm applied to any column
without a column-level or table-level default compression
specified at the time it was created
DISK_AUTO_OPTIMIZE_TIMEOUT
: Time interval in seconds after
which the database will apply optimizations/transformations to
persisted data, such as compression. The minimum allowed value
is '0'.
HA_CONSUMER_REPLAY_OFFSET
: Initializes HA replay from the given
timestamp (as milliseconds since unix epoch). The minimum
allowed value is '-1'.
propertyUpdatesMap
.public AlterSystemPropertiesRequest setPropertyUpdatesMap(Map<String,String> propertyUpdatesMap)
CONCURRENT_KERNEL_EXECUTION
: Enables concurrent kernel
execution if the value is TRUE
and disables it if the value is FALSE
.
Supported values:
SUBTASK_CONCURRENCY_LIMIT
: Sets the maximum number of
simultaneous threads allocated to a given request, on each rank.
Note that thread allocation may also be limited by resource
group limits and/or system load.
CHUNK_SIZE
: Sets the
number of records per chunk to be used for all new tables.
CHUNK_COLUMN_MAX_MEMORY
: Sets the target maximum data size for
each column in a chunk to be used for all new tables.
CHUNK_MAX_MEMORY
:
Indicates the target maximum data size for all columns in a
chunk to be used for all new tables.
EXECUTION_MODE
: Sets
the execution_mode for kernel executions to the specified string
value. Possible values are host, device, default (engine
decides) or an integer value that indicates max chunk size to
exec on host
EXTERNAL_FILES_DIRECTORY
: Sets the root directory path where
external table data files are accessed from. Path must exist on
the head node
REQUEST_TIMEOUT
:
Number of minutes after which filtering (e.g., GPUdb.filter
) and
aggregating (e.g., GPUdb.aggregateGroupBy
) queries will timeout. The default value
is '20'. The minimum allowed value is '0'. The maximum allowed
value is '1440'.
MAX_GET_RECORDS_SIZE
: The maximum number of records the
database will serve for a given data retrieval call. The default
value is '20000'. The minimum allowed value is '0'. The maximum
allowed value is '1000000'.
ENABLE_AUDIT
: Enable or
disable auditing.
AUDIT_HEADERS
: Enable
or disable auditing of request headers.
AUDIT_BODY
: Enable or
disable auditing of request bodies.
AUDIT_DATA
: Enable or
disable auditing of request data.
AUDIT_RESPONSE
: Enable
or disable auditing of response information.
SHADOW_AGG_SIZE
: Size
of the shadow aggregate chunk cache in bytes. The default value
is '10000000'. The minimum allowed value is '0'. The maximum
allowed value is '2147483647'.
SHADOW_FILTER_SIZE
: Size of the shadow filter chunk cache in
bytes. The default value is '10000000'. The minimum allowed
value is '0'. The maximum allowed value is '2147483647'.
ENABLE_OVERLAPPED_EQUI_JOIN
: Enable overlapped-equi-join
filter. The default value is 'true'.
ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN
: Enable the one_step
compound-equi-join algorithm. The default value is 'true'.
KAFKA_BATCH_SIZE
:
Maximum number of records to be ingested in a single batch. The
default value is '1000'. The minimum allowed value is '1'. The
maximum allowed value is '10000000'.
KAFKA_POLL_TIMEOUT
: Maximum time (milliseconds) for each poll
to get records from kafka. The default value is '0'. The minimum
allowed value is '0'. The maximum allowed value is '1000'.
KAFKA_WAIT_TIME
:
Maximum time (seconds) to buffer records received from kafka
before ingestion. The default value is '30'. The minimum allowed
value is '1'. The maximum allowed value is '120'.
EGRESS_PARQUET_COMPRESSION
: Parquet file compression type.
Supported values:
The default value is SNAPPY
.
EGRESS_SINGLE_FILE_MAX_SIZE
: Max file size (in MB) to allow
saving to a single file. May be overridden by target
limitations. The default value is '10000'. The minimum allowed
value is '1'. The maximum allowed value is '200000'.
MAX_CONCURRENT_KERNELS
: Sets the max_concurrent_kernels value
of the conf. The minimum allowed value is '0'. The maximum
allowed value is '256'.
SYSTEM_METADATA_RETENTION_PERIOD
: Sets the
system_metadata.retention_period value of the conf. The minimum
allowed value is '1'.
TCS_PER_TOM
: Size of the
worker rank data calculation thread pool. This is primarily
used for computation-based operations such as aggregates and
record retrieval. The minimum allowed value is '2'. The maximum
allowed value is '8192'.
TPS_PER_TOM
: Size of the
worker rank data processing thread pool. This includes
operations such as inserts, updates, & deletes on table data.
Multi-head inserts are not affected by this limit. The minimum
allowed value is '2'. The maximum allowed value is '8192'.
BACKGROUND_WORKER_THREADS
: Size of the worker rank background
thread pool. This includes background operations such as
watermark evictions catalog table updates. The minimum allowed
value is '1'. The maximum allowed value is '8192'.
LOG_DEBUG_JOB_INFO
: Outputs various job-related information to
the rank logs. Used for troubleshooting.
ENABLE_THREAD_HANG_LOGGING
: Log a stack trace for any thread
that runs longer than a defined threshold. Used for
troubleshooting. The default value is 'true'.
AI_ENABLE_RAG
: Enable
RAG. The default value is 'false'.
AI_API_PROVIDER
: AI
API provider type
AI_API_URL
: AI API URL
AI_API_KEY
: AI API key
AI_API_CONNECTION_TIMEOUT
: AI API connection timeout in seconds
AI_API_EMBEDDINGS_MODEL
: AI API model name
TELM_PERSIST_QUERY_METRICS
: Enable or disable persisting of
query metrics.
POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT
: Idle connection timeout
in seconds
POSTGRES_PROXY_KEEP_ALIVE
: Enable postgres proxy keep alive.
The default value is 'false'.
KIFS_DIRECTORY_DATA_LIMIT
: The default maximum capacity to
apply when creating a KiFS directory (bytes). The minimum
allowed value is '-1'.
COMPRESSION_CODEC
:
The default compression algorithm applied to any column
without a column-level or table-level default compression
specified at the time it was created
DISK_AUTO_OPTIMIZE_TIMEOUT
: Time interval in seconds after
which the database will apply optimizations/transformations to
persisted data, such as compression. The minimum allowed value
is '0'.
HA_CONSUMER_REPLAY_OFFSET
: Initializes HA replay from the given
timestamp (as milliseconds since unix epoch). The minimum
allowed value is '-1'.
propertyUpdatesMap
- The new value for propertyUpdatesMap
.this
to mimic the builder pattern.public Map<String,String> getOptions()
EVICT_TO_COLD
: If TRUE
and evict_columns is specified, the given
objects will be evicted to cold storage (if such a tier exists).
Supported values:
PERSIST
: If TRUE
the system configuration will be written to disk upon successful
application of this request. This will commit the changes from
this request and any additional in-memory modifications.
Supported values:
The default value is TRUE
.
Map
.options
.public AlterSystemPropertiesRequest setOptions(Map<String,String> options)
EVICT_TO_COLD
: If TRUE
and evict_columns is specified, the given
objects will be evicted to cold storage (if such a tier exists).
Supported values:
PERSIST
: If TRUE
the system configuration will be written to disk upon successful
application of this request. This will commit the changes from
this request and any additional in-memory modifications.
Supported values:
The default value is TRUE
.
Map
.options
- The new value for options
.this
to mimic the builder pattern.public org.apache.avro.Schema getSchema()
getSchema
in interface org.apache.avro.generic.GenericContainer
public Object get(int index)
get
in interface org.apache.avro.generic.IndexedRecord
index
- the position of the field to getIndexOutOfBoundsException
public void put(int index, Object value)
put
in interface org.apache.avro.generic.IndexedRecord
index
- the position of the field to setvalue
- the value to setIndexOutOfBoundsException
Copyright © 2025. All rights reserved.