AI Feature Functions

• gs_index_advise(text)

  Description: Recommends an index for a single query statement.

  Parameter: SQL statement string

  Return type: record

  Single-query Index Recommendation describes the examples.

• hypopg_create_index(text)

  Description: Creates a virtual index.

  Parameter: character string of the statement for creating an index

  Return type: record

  Virtual Index describes the examples.

• hypopg_display_index()

  Description: Displays information about all created virtual indexes.

  Parameter: none

  Return type: record

  Virtual Index describes the examples.

• hypopg_drop_index(oid)

  Description: Deletes a specified virtual index.

  Parameter: OID of the index

  Return type: Boolean

  Virtual Index describes the examples.

• hypopg_reset_index()

  Description: Clears all virtual indexes.

  Parameter: none

  Return type: none

  Virtual Index describes the examples.

• hypopg_estimate_size(oid)

  Description: Estimates the space required for creating a specified index.

  Parameter: OID of the index

  Return type: int8

  Virtual Index describes the examples.

• check_engine_status(ip text, port text)

  Description: Tests whether a predictor engine provides services on a specified IP address and port.

  Parameter: IP address and port number of the predictor engine.

  Return type: text

  User Guide describes the examples.

• encode_plan_node(optname text, orientation text, strategy text, options text, dop int8, quals text, projection text)

  Description: Encodes the plan operator information in the input parameters.

  Parameter: plan operator information

  Return type: text.

  NOTE: This function is an internal function. You are not advised to use it directly.

• model_train_opt(template text, model text)

  Description: Trains a given query performance prediction model.

  Parameters: template name and model name of the performance prediction model

  Return type: tartup_time_accuracy FLOAT8, total_time_accuracy FLOAT8, rows_accuracy FLOAT8, peak_memory_accuracy FLOAT8

  User Guide describes the examples.

• track_model_train_opt(ip text, port text)

  Description: Returns the training log address of the specified IP address and port predictor engine.

  Parameter: IP address and port number of the predictor engine

  Return type: text

  User Guide describes the examples.

• encode_feature_perf_hist(datname text)

  Description: Encodes historical plan operators collected in the target database.

  Parameter: database name

  Return type: queryid bigint, plan_node_id int, parent_node_id int, left_child_id int, right_child_id int, encode text, startup_time bigint, total_time bigint, rows bigint, and peak_memory int

  User Guide describes the examples.

• gather_encoding_info(datname text)

  Description: Invokes encode_feature_perf_hist to save the encoded data persistently.

  Parameter: database name

  Return type: int

  User Guide describes the examples.

• db4ai_predict_by_bool (text, VARIADIC "any")

  Description: Obtains a model whose return value is of the Boolean type for model inference. This function is an internal function. You are advised to use the PREDICT BY syntax for inference.

  Parameter: model name and input column name of the inference task

  Return type: Boolean

• db4ai_predict_by_float4(text, VARIADIC "any")

  Description: Obtains a model whose return value is of the float4 type for model inference. This function is an internal function. You are advised to use the PREDICT BY syntax for inference.

  Parameter: model name and input column name of the inference task

  Return type: float

• db4ai_predict_by_float8(text, VARIADIC "any")

  Description: Obtains a model whose return value is of the float8 type for model inference. This function is an internal function. You are advised to use the PREDICT BY syntax for inference.

  Parameter: model name and input column name of the inference task

  Return type: float

• db4ai_predict_by_int32(text, VARIADIC "any")

  Description: Obtains a model whose return value is of the int32 type for model inference. This function is an internal function. You are advised to use the PREDICT BY syntax for inference.

  Parameter: model name and input column name of the inference task

  Return type: int

• db4ai_predict_by_int64(text, VARIADIC "any")

  Description: Obtains a model whose return value is of the int64 type for model inference. This function is an internal function. You are advised to use the PREDICT BY syntax for inference.

  Parameter: model name and input column name of the inference task

  Return type: int

• db4ai_predict_by_numeric(text, VARIADIC "any")

  Description: Obtains a model whose return value is of the numeric type for model inference. This function is an internal function. You are advised to use the PREDICT BY syntax for inference.

  Parameter: model name and input column name of the inference task

  Return type: numeric

• db4ai_predict_by_text(text, VARIADIC "any")

  Description: Obtains a model whose return value is of the character type for model inference. This function is an internal function. You are advised to use the PREDICT BY syntax for inference.

  Parameter: model name and input column name of the inference task

  Return type: text