> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.AlterTableRequest.Options > kinetica.AlterTableRequest.Options — Kinetica C# API

A set of string constants for the parameter AlterTableRequest.options. More...

Static Public Attributes
const string  ACTION = "action"
  A constant for the AlterTableRequest.Options options.
 
const string  COLUMN\_NAME = "column\_name"
  A constant for the AlterTableRequest.Options options.
 
const string  TABLE\_NAME = "table\_name"
  A constant for the AlterTableRequest.Options options.
 
const string  COLUMN\_DEFAULT\_VALUE = "column\_default\_value"
  When adding a column, set a literal default value for existing records.
 
const string  COLUMN\_PROPERTIES = "column\_properties"
  When adding or changing a column, set the column properties (strings, separated by a comma: data, text\_search, char8, int8 etc).
 
const string  COLUMN\_TYPE = "column\_type"
  When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).
 
const string  COPY\_VALUES\_FROM\_COLUMN = "copy\_values\_from\_column"
  \[DEPRECATED] Please use ADD\_COLUMN\_EXPRESSION instead.
 
const string  RENAME\_COLUMN = "rename\_column"
  When changing a column, specify new column name.
 
const string  VALIDATE\_CHANGE\_COLUMN = "validate\_change\_column"
  When changing a column, validate the change before applying it (or not).
 
const string  TRUE = "true"
  A boolean constant for the AlterTableRequest.Options options.
 
const string  FALSE = "false"
  A boolean constant for the AlterTableRequest.Options options.
 
const string  UPDATE\_LAST\_ACCESS\_TIME = "update\_last\_access\_time"
  Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table's TTL.
 
const string  ADD\_COLUMN\_EXPRESSION = "add\_column\_expression"
  When adding a column or setting a new default with AlterTableRequest.action set to SET\_DEFAULT, the new default expression (GPUdb-syntax) for the column.
 
const string  ADD\_COLUMN\_EXPRESSION\_SQL = "add\_column\_expression\_sql"
  Optional SQL-syntax form of ADD\_COLUMN\_EXPRESSION, used only when the SQL syntax differs from the GPUdb syntax.
 
const string  STRATEGY\_DEFINITION = "strategy\_definition"
  Parameter for specifying the tier strategy for the table and its columns when AlterTableRequest.action is SET\_STRATEGY\_DEFINITION, replacing the existing tier strategy in its entirety.
 
const string  INDEX\_TYPE = "index\_type"
  Type of index to create, when AlterTableRequest.action is CREATE\_INDEX; to refresh, when AlterTableRequest.action is REFRESH\_INDEX; or to delete, when AlterTableRequest.action is DELETE\_INDEX.
 
const string  COLUMN = "column"
  Create or delete a column (attribute) index.
 
const string  LOW\_CARDINALITY = "low\_cardinality"
  Create a low-cardinality column (attribute) index.
 
const string  CHUNK\_SKIP = "chunk\_skip"
  Create or delete a chunk skip index.
 
const string  GEOSPATIAL = "geospatial"
  Create or delete a geospatial index.
 
const string  CAGRA = "cagra"
  Create or delete a CAGRA index on a vector column.
 
const string  HNSW = "hnsw"
  Create or delete an HNSW index on a vector column.
 
const string  INDEX\_OPTIONS = "index\_options"
  Options to use when creating an index, in the format "key: value \[, key: value \[, ...]]".
 

Detailed Description

A set of string constants for the parameter AlterTableRequest.options.

Optional parameters.

Definition at line 366 of file AlterTable.cs.

Member Data Documentation

◆ ACTION

const string kinetica.AlterTableRequest.Options.ACTION = "action"
static

A constant for the AlterTableRequest.Options options.

Definition at line 370 of file AlterTable.cs.

◆ ADD\_COLUMN\_EXPRESSION

const string kinetica.AlterTableRequest.Options.ADD\_COLUMN\_EXPRESSION = "add\_column\_expression"
static

When adding a column or setting a new default with AlterTableRequest.action set to SET\_DEFAULT, the new default expression (GPUdb-syntax) for the column.

Any valid expression may be used, including one containing references to existing columns in the same table. Persisted as the column's default for future inserts that omit the column; for add\_column, also used to backfill existing rows.

Definition at line 467 of file AlterTable.cs.

◆ ADD\_COLUMN\_EXPRESSION\_SQL

const string kinetica.AlterTableRequest.Options.ADD\_COLUMN\_EXPRESSION\_SQL = "add\_column\_expression\_sql"
static

Optional SQL-syntax form of ADD\_COLUMN\_EXPRESSION, used only when the SQL syntax differs from the GPUdb syntax.

Persisted alongside the GPUdb form so SHOW CREATE TABLE / information\_schema can reproduce the original SQL.

Definition at line 476 of file AlterTable.cs.

◆ CAGRA

const string kinetica.AlterTableRequest.Options.CAGRA = "cagra"
static

Create or delete a CAGRA index on a vector column.

Definition at line 578 of file AlterTable.cs.

◆ CHUNK\_SKIP

const string kinetica.AlterTableRequest.Options.CHUNK\_SKIP = "chunk\_skip"
static

Create or delete a chunk skip index.

Definition at line 567 of file AlterTable.cs.

◆ COLUMN

const string kinetica.AlterTableRequest.Options.COLUMN = "column"
static

Create or delete a column (attribute) index.

Definition at line 556 of file AlterTable.cs.

◆ COLUMN\_DEFAULT\_VALUE

const string kinetica.AlterTableRequest.Options.COLUMN\_DEFAULT\_VALUE = "column\_default\_value"
static

When adding a column, set a literal default value for existing records.

For nullable columns, the default value will be null, regardless of data type. Also persisted as the column's default for future inserts that omit the column.

Definition at line 385 of file AlterTable.cs.

◆ COLUMN\_NAME

const string kinetica.AlterTableRequest.Options.COLUMN\_NAME = "column\_name"
static

A constant for the AlterTableRequest.Options options.

Definition at line 374 of file AlterTable.cs.

◆ COLUMN\_PROPERTIES

const string kinetica.AlterTableRequest.Options.COLUMN\_PROPERTIES = "column\_properties"
static

When adding or changing a column, set the column properties (strings, separated by a comma: data, text\_search, char8, int8 etc).

Definition at line 390 of file AlterTable.cs.

◆ COLUMN\_TYPE

const string kinetica.AlterTableRequest.Options.COLUMN\_TYPE = "column\_type"
static

When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).

Definition at line 395 of file AlterTable.cs.

◆ COPY\_VALUES\_FROM\_COLUMN

const string kinetica.AlterTableRequest.Options.COPY\_VALUES\_FROM\_COLUMN = "copy\_values\_from\_column"
static

\[DEPRECATED] Please use ADD\_COLUMN\_EXPRESSION instead.

Definition at line 400 of file AlterTable.cs.

◆ FALSE

const string kinetica.AlterTableRequest.Options.FALSE = "false"
static

A boolean constant for the AlterTableRequest.Options options.

Definition at line 433 of file AlterTable.cs.

◆ GEOSPATIAL

const string kinetica.AlterTableRequest.Options.GEOSPATIAL = "geospatial"
static

Create or delete a geospatial index.

Definition at line 572 of file AlterTable.cs.

◆ HNSW

const string kinetica.AlterTableRequest.Options.HNSW = "hnsw"
static

Create or delete an HNSW index on a vector column.

Definition at line 584 of file AlterTable.cs.

◆ INDEX\_OPTIONS

const string kinetica.AlterTableRequest.Options.INDEX\_OPTIONS = "index\_options"
static

Options to use when creating an index, in the format "key: value \[, key: value \[, ...]]".

Valid options vary by index type.

Definition at line 589 of file AlterTable.cs.

◆ INDEX\_TYPE

const string kinetica.AlterTableRequest.Options.INDEX\_TYPE = "index\_type"
static

Type of index to create, when AlterTableRequest.action is CREATE\_INDEX; to refresh, when AlterTableRequest.action is REFRESH\_INDEX; or to delete, when AlterTableRequest.action is DELETE\_INDEX.

Supported values:

The default value is COLUMN.

Definition at line 551 of file AlterTable.cs.

◆ LOW\_CARDINALITY

const string kinetica.AlterTableRequest.Options.LOW\_CARDINALITY = "low\_cardinality"
static

Create a low-cardinality column (attribute) index.

Definition at line 562 of file AlterTable.cs.

◆ RENAME\_COLUMN

const string kinetica.AlterTableRequest.Options.RENAME\_COLUMN = "rename\_column"
static

When changing a column, specify new column name.

Definition at line 403 of file AlterTable.cs.

◆ STRATEGY\_DEFINITION

const string kinetica.AlterTableRequest.Options.STRATEGY\_DEFINITION = "strategy\_definition"
static

Parameter for specifying the tier strategy for the table and its columns when AlterTableRequest.action is SET\_STRATEGY\_DEFINITION, replacing the existing tier strategy in its entirety.

Definition at line 484 of file AlterTable.cs.

◆ TABLE\_NAME

const string kinetica.AlterTableRequest.Options.TABLE\_NAME = "table\_name"
static

A constant for the AlterTableRequest.Options options.

Definition at line 378 of file AlterTable.cs.

◆ TRUE

const string kinetica.AlterTableRequest.Options.TRUE = "true"
static

A boolean constant for the AlterTableRequest.Options options.

Definition at line 429 of file AlterTable.cs.

◆ UPDATE\_LAST\_ACCESS\_TIME

const string kinetica.AlterTableRequest.Options.UPDATE\_LAST\_ACCESS\_TIME = "update\_last\_access\_time"
static

Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table's TTL.

Supported values:

  • TRUE: Reset the expiration countdown timer to the table's configured TTL.
  • FALSE: Don't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed.

The default value is TRUE.

Definition at line 456 of file AlterTable.cs.

◆ VALIDATE\_CHANGE\_COLUMN

const string kinetica.AlterTableRequest.Options.VALIDATE\_CHANGE\_COLUMN = "validate\_change\_column"
static

When changing a column, validate the change before applying it (or not).

Supported values:

  • TRUE: Validate all values. A value too large (or too long) for the new type will prevent any change.
  • FALSE: When a value is too large or long, it will be truncated.

The default value is TRUE.

Definition at line 425 of file AlterTable.cs.

The documentation for this struct was generated from the following files: