diff --git a/docs/flex/interactive/configuration.md b/docs/flex/interactive/configuration.md index edcfb20554a2..ac4dd0ec3561 100644 --- a/docs/flex/interactive/configuration.md +++ b/docs/flex/interactive/configuration.md @@ -34,10 +34,10 @@ Here's a glimpse of what a typical YAML configuration file might look like: ```yaml log_level: INFO # default INFO compute_engine: - shard_num: 1 # the number of shared workers, default 1 + thread_num_per_worker: 1 # the number of shared workers, default 1 compiler: planner: - is_one: true + is_on: true opt: RBO rules: - FilterMatchRule @@ -63,8 +63,8 @@ In this following table, we use the `.` notation to represent the hierarchy with | -------- | -------- | -------- |----------- | | log_level | INFO | The level of database log, INFO/DEBUG/ERROR | 0.0.1 | |default_graph | modern | The name of default graph on which to start the graph service. | 0.0.1 | -| compute_engine.shard_num | 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.isOn | true | Determines if query optimization is enabled for compiling Cypher queries | 0.0.1 | +| 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 | diff --git a/docs/flex/interactive/custom_graph_data.md b/docs/flex/interactive/custom_graph_data.md index 52fb1a2f8be9..0834a07f91c8 100644 --- a/docs/flex/interactive/custom_graph_data.md +++ b/docs/flex/interactive/custom_graph_data.md @@ -118,7 +118,10 @@ Supported primitive data types for properties include: - DT_SIGNED_INT64 - DT_UNSIGNED_INT64 - DT_BOOL +- DT_FLOAT +- DT_DOUBLE - DT_STRING +- DT_DATE32 For a comprehensive list of supported types, please refer to the [data model](./data_model) page. diff --git a/docs/flex/interactive/data_model.md b/docs/flex/interactive/data_model.md index 443053fab622..01f9dcd25c2b 100644 --- a/docs/flex/interactive/data_model.md +++ b/docs/flex/interactive/data_model.md @@ -18,10 +18,10 @@ Within the `graph.yaml` file, vertices are delineated under the `vertex_types` s properties: - property_name: id property_type: - primitive_type: DT_SIGNED_INT64 + primitive_type: DT_SIGNED_INT64 - property_name: name property_type: - primitive_type: DT_STRING + primitive_type: DT_STRING primary_keys: # these must also be listed in the properties - id ``` diff --git a/docs/flex/interactive/development/admin_service.md b/docs/flex/interactive/development/admin_service.md index b6ca3919953c..241b78137896 100644 --- a/docs/flex/interactive/development/admin_service.md +++ b/docs/flex/interactive/development/admin_service.md @@ -6,24 +6,24 @@ Welcome to the GraphScope Interactive Admin Service documentation. This guide is ## API Overview -The table below provides an overview of the available APIs, categorized for ease of understanding: - - -| Category | API name | Method | URL | Explanation | -|---------------------|-----------------|--------|---------------------------------------|--------------------------------------------------------------------| -| GraphManagement | ListGraphs | GET | /v1/graph | Get all graphs in current interactive service, the schema for each graph is returned. | -| GraphManagement | GetGraphSchema | GET | /v1/graph/{graph_name}/schema | Get the schema for the specified graph. | -| GraphManagement | CreateGraph | POST | /v1/graph | Create an empty graph with the specified schema. | -| GraphManagement | DeleteGraph | DELETE | /v1/graph/{graph_name} | Delete the specified graph. | -| GraphManagement | ImportGraph | POST | /v1/graph/{graph_name}/dataloading | Import data to graph. | -| ProcedureManagement | CreateProcedure | POST | /v1/graph/{graph_name}/procedure | Create a new stored procedure bound to a graph. | -| ProcedureManagement | ShowProcedures | GET | /v1/graph/{graph_name}/procedure | Get all procedures bound to the specified graph. | -| ProcedureManagement | GetProcedure | GET | /v1/graph/{graph_name}/procedure/{procedure_name} | Get the metadata of the procedure. | -| ProcedureManagement | DeleteProcedure | DELETE | /v1/graph/{graph_name}/procedure/{procedure_name} | Delete the specified procedure. | -| ProcedureManagement | UpdateProcedure | PUT | /v1/graph/{graph_name}/procedure/{procedure_name} | Update some metadata for the specified procedure, i.e. update description, enable/disable. | -| ServiceManagement | StartService | POST | /v1/service/start | Start the service on the graph specified in request body. | -| ServiceManagement | ServiceStatus | GET | /v1/service/status | Get current service status. | -| SystemMetrics | SystemMetrics | GET | /v1/node/status | Get the system metrics of current host/pod, i.e. CPU usage, memory usages. | +The table below provides an overview of the available APIs: + + +| API name | Method and URL | Explanation | +|-----------------|---------------------------------------|--------------------------------------------------------------------| +| ListGraphs | GET /v1/graph | Get all graphs in current interactive service, the schema for each graph is returned. | +| GetGraphSchema | GET /v1/graph/{graph}/schema | Get the schema for the specified graph. | +| CreateGraph | POST /v1/graph | Create an empty graph with the specified schema. | +| DeleteGraph | DELETE /v1/graph/{graph} | Delete the specified graph. | +| ImportGraph | POST /v1/graph/{graph}/dataloading | Import data to graph. | +| CreateProcedure | POST /v1/graph/{graph}/procedure | Create a new stored procedure bound to a graph. | +| ShowProcedures | GET /v1/graph/{graph}/procedure | Get all procedures bound to the specified graph. | +| GetProcedure | GET /v1/graph/{graph}/procedure/{proc_name} | Get the metadata of the procedure. | +| DeleteProcedure | DELETE /v1/graph/{graph}/procedure/{proc_name} | Delete the specified procedure. | +| UpdateProcedure | PUT /v1/graph/{graph}/procedure/{proc_name} | Update some metadata for the specified procedure, i.e. update description, enable/disable. | +| StartService | POST /v1/service/start | Start the service on the graph specified in request body. | +| ServiceStatus | GET /v1/service/status | Get current service status. | +| SystemMetrics | GET /v1/node/status | Get the system metrics of current host/pod, i.e. CPU usage, memory usages. | ## Detailed API Documentation