Skip to content

Commit

Permalink
Generate latest docs on CI, from commit d1d53f2.
Browse files Browse the repository at this point in the history 
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
@github-actions
github-actions[bot] committed Dec 1, 2023
1 parent cf7f83f commit 4841bfd
Show file tree
Hide file tree
Showing 2,734 changed files with 25,972 additions and 18,402 deletions.
30 changes: 30 additions & 0 deletions _redirects
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/docs/v0.22.0/* /docs/latest/:splat
/docs/v0.21.0/* /docs/latest/:splat
/docs/v0.20.0/* /docs/latest/:splat
/docs/v0.19.0/* /docs/latest/:splat
/docs/v0.18.0/* /docs/latest/:splat
/docs/v0.17.0/* /docs/latest/:splat
/docs/v0.16.0/* /docs/latest/:splat
/docs/v0.15.0/* /docs/latest/:splat
/docs/v0.14.0/* /docs/latest/:splat
/docs/v0.13.0/* /docs/latest/:splat
/docs/v0.12.0/* /docs/latest/:splat
/docs/v0.11.0/* /docs/latest/:splat
/docs/v0.10.1/* /docs/latest/:splat
/docs/v0.10.0/* /docs/latest/:splat
/docs/v0.9.1/* /docs/latest/:splat
/docs/v0.9.0/* /docs/latest/:splat
/docs/v0.8.0/* /docs/latest/:splat
/docs/v0.7.0/* /docs/latest/:splat
/docs/v0.6.1/* /docs/latest/:splat
/docs/v0.6.0/* /docs/latest/:splat
/docs/v0.5.0/* /docs/latest/:splat
/docs/v0.4.1/* /docs/latest/:splat
/docs/v0.4.0/* /docs/latest/:splat
/docs/v0.3.0/* /docs/latest/:splat
/docs/v0.2.1/* /docs/latest/:splat
/docs/v0.2.0/* /docs/latest/:splat
/docs/v0.1.3/* /docs/latest/:splat
/docs/v0.1.2/* /docs/latest/:splat
/docs/v0.1.1/* /docs/latest/:splat
/docs/v0.1.0/* /docs/latest/:splat
8 changes: 4 additions & 4 deletions docs/latest/_sources/flex/interactive/configuration.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 |
Expand Down
3 changes: 3 additions & 0 deletions docs/latest/_sources/flex/interactive/custom_graph_data.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/latest/_sources/flex/interactive/data_model.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
36 changes: 18 additions & 18 deletions docs/latest/_sources/flex/interactive/development/admin_service.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/latest/_sources/flex/interactive/overview.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ GraphScope Interactive boasts several key features:
3. **Future-Ready Expansion Capabilities**: Drawing from the prowess of GraphScope Flex, GraphScope Interactive is primed for adaptability:
* Support for Multiple Query Languages: In the near future, GraphScope Interactive will extend its language support to include [Gremlin](https://tinkerpop.apache.org/gremlin.html), and [GQL](https://www.gqlstandards.org/), further enhancing its versatility.
* Scalability: GraphScope Interactive possesses the potential for distributed processing. This means it can be expanded with few effort to handle larger-scale graphs, ensuring it remains effective as your data grows.
4. **Massive Graph Support**: To enhance system throughput and query performance, we store all graph data in memory by default. However, when encountering graph data too large to fit entirely in memory, we offload excess data to disk storage. This approach, while effectively handling massive-scale graph data, may result in reduced throughput. Moving forward, we aim to adopt a master-slave architecture designed to enhance concurrent querying performance. This will be achieved by distributing the workload across multiple machines, thereby optimizing resource utilization to improve throughput.

## Property Graph Model and Graph Queries

Expand Down
26 changes: 26 additions & 0 deletions docs/latest/_sources/storage_engine/groot.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -568,6 +568,32 @@ APIs including:

Refer to [RealtimeWrite.java](https://github.com/alibaba/GraphScope/blob/main/interactive_engine/groot-client/src/main/java/com/alibaba/graphscope/groot/sdk/example/RealtimeWrite.java) for examples.


### Other features

Groot could enable user to replay realtime write records from a specific offset, or a timestamp, this is useful when you want to restore some records before
a offline load finished, since offload will overwrite all records.

You can only specify one of `offset` and `timestamp`. The other unused one must be set to -1. If not, `offset` will take precedence.

Example API:
- Python:
```python
import time
import graphscope
conn = graphscope.conn()
current_timestamp = int(time.time() * 1000) - 100 * 60 * 1000

r = conn.replay_records(-1, current_timestamp)
```
- Java

```java
GrootClient client = GrootClientBuilder.build();
long timestamp = System.currentTimeMillis();
client.replayRecords(-1, timestamp);
```

## Uninstalling and Restarting

### Uninstall Groot
Expand Down
8 changes: 4 additions & 4 deletions docs/latest/flex/interactive/configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -709,10 +709,10 @@ <h2>Sample Configuration<a class="headerlink" href="#sample-configuration" title
<p>Here’s a glimpse of what a typical YAML configuration file might look like:</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">log_level</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">INFO</span><span class="w"> </span><span class="c1"># default INFO</span>
<span class="nt">compute_engine</span><span class="p">:</span>
<span class="w"> </span><span class="nt">shard_num</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span><span class="w"> </span><span class="c1"># the number of shared workers, default 1</span>
<span class="w"> </span><span class="nt">thread_num_per_worker</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span><span class="w"> </span><span class="c1"># the number of shared workers, default 1</span>
<span class="nt">compiler</span><span class="p">:</span>
<span class="w"> </span><span class="nt">planner</span><span class="p">:</span>
<span class="w"> </span><span class="nt">is_one</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
<span class="w"> </span><span class="nt">is_on</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
<span class="w"> </span><span class="nt">opt</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">RBO</span>
<span class="w"> </span><span class="nt">rules</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">FilterMatchRule</span>
Expand Down Expand Up @@ -752,12 +752,12 @@ <h3>Service configurations<a class="headerlink" href="#service-configurations" t
<td><p>The name of default graph on which to start the graph service.</p></td>
<td><p>0.0.1</p></td>
</tr>
<tr class="row-even"><td><p>compute_engine.shard_num</p></td>
<tr class="row-even"><td><p>compute_engine.thread_num_per_worker</p></td>
<td><p>1</p></td>
<td><p>The number of threads will be used to process the queries. Increase the number can benefit the query throughput</p></td>
<td><p>0.0.1</p></td>
</tr>
<tr class="row-odd"><td><p>compiler.planner.isOn</p></td>
<tr class="row-odd"><td><p>compiler.planner.is_on</p></td>
<td><p>true</p></td>
<td><p>Determines if query optimization is enabled for compiling Cypher queries</p></td>
<td><p>0.0.1</p></td>
Expand Down
3 changes: 3 additions & 0 deletions docs/latest/flex/interactive/custom_graph_data.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -797,7 +797,10 @@ <h2>Step 1: Create a New Graph<a class="headerlink" href="#step-1-create-a-new-g
<li><p>DT_SIGNED_INT64</p></li>
<li><p>DT_UNSIGNED_INT64</p></li>
<li><p>DT_BOOL</p></li>
<li><p>DT_FLOAT</p></li>
<li><p>DT_DOUBLE</p></li>
<li><p>DT_STRING</p></li>
<li><p>DT_DATE32</p></li>
</ul>
<p>For a comprehensive list of supported types, please refer to the <a class="reference internal" href="data_model.html"><span class="doc std std-doc">data model</span></a> page.</p>
</section>
Expand Down
4 changes: 2 additions & 2 deletions docs/latest/flex/interactive/data_model.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -699,10 +699,10 @@ <h2>Graph Data<a class="headerlink" href="#graph-data" title="Permalink to this
<span class="w"> </span><span class="nt">properties</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">property_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">id</span>
<span class="w"> </span><span class="nt">property_type</span><span class="p">:</span>
<span class="w"> </span><span class="nt">primitive_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">DT_SIGNED_INT64</span>
<span class="w"> </span><span class="nt">primitive_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">DT_SIGNED_INT64</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">property_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">name</span>
<span class="w"> </span><span class="nt">property_type</span><span class="p">:</span>
<span class="w"> </span><span class="nt">primitive_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">DT_STRING</span>
<span class="w"> </span><span class="nt">primitive_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">DT_STRING</span>
<span class="w"> </span><span class="nt">primary_keys</span><span class="p">:</span><span class="w"> </span><span class="c1"># these must also be listed in the properties</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">id</span><span class="w"> </span>
</pre></div>
Expand Down
Loading

0 comments on commit 4841bfd

Please sign in to comment.