Skip to main content
Version: 0.9 🚧

Procedures

Fluss provides stored procedures to perform administrative and management operations through Spark SQL. All procedures are located in the sys namespace and can be invoked using the CALL statement.

Configuration​

To enable Fluss procedures in Spark, you need to configure the Spark session extensions:

spark.conf.set("spark.sql.extensions", "org.apache.fluss.spark.FlussSparkSessionExtensions")

Or in spark-defaults.conf:

spark.sql.extensions=org.apache.fluss.spark.FlussSparkSessionExtensions

Syntax​

The general syntax for calling a procedure is:

CALL [catalog_name.]sys.procedure_name(
  parameter_name => 'value',
  another_parameter => 'value'
)

Argument Passing​

Procedures support two ways to pass arguments:

  1. Named Arguments (recommended):

    CALL catalog.sys.procedure_name(parameter => 'value')

  2. Positional Arguments:

    CALL catalog.sys.procedure_name('value')

Note: You cannot mix named and positional arguments in a single procedure call.

Cluster Configuration Procedures​

Fluss provides procedures to dynamically manage cluster configurations without requiring a server restart.

get_cluster_configs​

Retrieve cluster configuration values.

Syntax:

CALL [catalog_name.]sys.get_cluster_configs()
CALL [catalog_name.]sys.get_cluster_configs(config_keys => ARRAY('key1', 'key2'))

Parameters:

  • config_keys (optional): Array of configuration keys to retrieve. If omitted, returns all cluster configurations.

Returns: A table with columns:

  • config_key: The configuration key name
  • config_value: The current value
  • config_source: The source of the configuration (e.g., DEFAULT, DYNAMIC, STATIC)

Example:

Spark SQL
-- Use the Fluss catalog (replace 'fluss_catalog' with your catalog name if different)
USE fluss_catalog;

-- Get all cluster configurations
CALL sys.get_cluster_configs();

-- Get specific configurations
CALL sys.get_cluster_configs(config_keys => ARRAY('kv.rocksdb.shared-rate-limiter.bytes-per-sec', 'datalake.format'));

Error Handling​

Procedures will throw exceptions in the following cases:

  • Missing Required Parameters: If a required parameter is not provided
  • Invalid Procedure Name: If the specified procedure does not exist
  • Type Mismatch: If a parameter value cannot be converted to the expected type
  • Permission Denied: If the user does not have permission to perform the operation

Implementation Notes​

  • Procedures are executed synchronously and return results immediately
  • The sys namespace is reserved for system procedures
  • Custom procedures can be added by implementing the Procedure interface

See Also​