Configuration

Configurable Items for Deploying Interactive with gsctl

When deploying Interactive using gsctl, various items can be configured. For a given configurable item named item-name, you can set its value as follows:

gsctl instance deploy --type interactive [--item-name=value]

Below is a list of all configurable items:

Item Name	Default	Description	Since Version
coordinator-port	8080	The port of the coordinator service	v0.3
admin-port	7777	The port of the interactive admin service	v0.3
storedproc-port	10000	The port of the interactive stored procedure service	v0.3
cypher-port	7687	The port of the cypher service	v0.3
config	None	The customized configuration file for engine interactive service	v0.4

Ports

By default, Interactive will launch the following services on these ports:

• Coordinator Service: 8080

• Interactive Meta Service: 7777

• Interactive Cypher Service: 7687

• Stored Procedure Service: 10000

You can customize these ports as needed. For example:

gsctl instance deploy --type interactive --coordinator-port 8081 --admin-port 7778 --cypher-port 7688 --storedproc-port 10001

Service Configuration

By default, Interactive will initialize the service with its default settings. However, GraphScope Interactive is designed to be flexible and adaptable to your specific needs. This means you can tailor the service’s behavior using custom configurations.

Customizing Your Service Configuration

To customize the service’s settings, you can provide a YAML configuration file interactive_config.yaml. This file allows you to specify various parameters, from directory paths to log levels, ensuring the service aligns with your requirements. To use a custom configuration, simply pass the YAML file to the command as follows:

gsctl instance deploy --type interactive --config ./interactive_config.yaml

Note

Please be aware that you’re not required to configure every option. Simply adjust the settings that are relevant to your needs. Any options left unconfigured will automatically adopt their default values, as detailed in the following sections.

Sample Configuration

Here’s a glimpse of what a typical YAML configuration file might look like:

log_level: INFO # default INFO, available(INFO,WARNING,ERROR,FATAL)
verbose_level: 0 # default 0, should be a int in range [0,10]. 10 will verbose all logs
compute_engine:
  thread_num_per_worker: 1  # the number of threads for each worker, default 1
compiler:
  planner:
    is_on: true
    opt: RBO
    rules:
      - FilterMatchRule
      - FilterIntoJoinRule
      - NotExistToAntiJoinRule
  query_timeout: 20000  # query timeout in milliseconds, default 20000

Available Configurations

In this following table, we use the . notation to represent the hierarchy within the YAML structure.

PropertyName	Default	Meaning	Since Version
log_level	INFO	The level of database log, INFO/WARNING/ERROR/FATAL	0.0.1
verbose_level	0	The verbose level of database log, should be a int	0.0.3
compute_engine.thread_num_per_worker	1	The number of threads will be used to process the queries. Increase the number can benefit the query throughput	0.0.1
compiler.planner.is_on	true	Determines if query optimization is enabled for compiling Cypher queries	0.0.1
compiler.planner.opt	RBO	Specifies the optimizer to be used for query optimization. Currently, only the Rule-Based Optimizer (RBO) is supported	0.0.1
compiler.planner.rules.FilterMatchRule	N/A	An optimization rule that pushes filter (Where) conditions into the Match clause	0.0.1
compiler.planner.rules.FilterIntoJoinRule	N/A	A native Calcite optimization rule that pushes filter conditions to the Join participants before performing the join	0.0.1
compiler.planner.rules.NotMatchToAntiJoinRule	N/A	An optimization rule that transforms a “not exist” pattern into an anti-join operation	0.0.1
compiler.query_timeout	3000000 ｜ The maximum time for compiler to wait engine’s reply, in ms	0.0.3

TODOs

We currently only allow service configuration during instance deployment. In the near future, we will support:

• Graph-level configurations

• Modifying service configurations