Skip to main content

Constants for the fields of the /aggregate/kmeans request.

Option fields

options

Constants for options.

pub const CREATE_TEMP_TABLE: &str = “create_temp_table”;

If true, a unique temporary table name will be generated in the sys_temp schema and used in place of result_table. If result_table_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_result_table_name.

pub const FALSE: &str = “false”;
pub const MAX_ITERS: &str = “max_iters”;

Number of times to try to hit the tolerance limit before giving up - default is 10.

pub const NUM_TRIES: &str = “num_tries”;

Number of times to run the k-means algorithm with a different randomly selected starting points - helps avoid local minimum. Default is 1.

pub const RESULT_TABLE: &str = “result_table”;

The name of a table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If this option is specified, the results are not returned in the response.

pub const RESULT_TABLE_PERSIST: &str = “result_table_persist”;

If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise.

pub const TRUE: &str = “true”;
pub const TTL: &str = “ttl”;

Sets the TTL of the table specified in result_table.

pub const WHITEN: &str = “whiten”;

When set to 1 each of the columns is first normalized by its stdv - default is not to whiten.