You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@age.apache.org by pd...@apache.org on 2022/06/07 08:05:26 UTC
[incubator-age-website] 01/01: Remove unlinked documentation on main page
This is an automated email from the ASF dual-hosted git repository.
pdpotter pushed a commit to branch pdpotter-remov-docs-on-main
in repository https://gitbox.apache.org/repos/asf/incubator-age-website.git
commit 5912a198dd47e367743bca16e08c1347462fea67
Author: Pieterjan De Potter <pi...@ugent.be>
AuthorDate: Tue Jun 7 10:05:22 2022 +0200
Remove unlinked documentation on main page
---
index.html | 194 -------------------------------------------------------------
1 file changed, 194 deletions(-)
diff --git a/index.html b/index.html
index 67452fe..933ca18 100644
--- a/index.html
+++ b/index.html
@@ -379,200 +379,6 @@
</div>
</div>
- <!--
- *
- * DOCUMENTATION
- *
- -->
- <div class="main-item" id="main-installing">
- <div class="heading"><h1>Installing AGE</h1></div>
- <div class="heading"><h2>Using Docker</h2></div>
- <div class="main-body">
- Docker images are available on Docker Hub and are based on the official PostgreSQL 11 Debian and Alpine images. <br />
- <ul>
- <li><a class="external-link" target="_blank" href="https://hub.docker.com/r/sorrell/agensgraph-extension">AGE Debian Docker Image</a></li>
- <li><a class="external-link" target="_blank" href="https://hub.docker.com/r/sorrell/agensgraph-extension-alpine">AGE Alpine Docker Image</a></li>
- </ul>
- </div>
- <div class="heading"><h2>Installing from source</h2></div>
- <div class="main-body">
- Building AGE from source depends on the following Linux libraries (Ubuntu package names shown below):
-
- <div class="code">$ sudo apt-get install bison build-essential flex postgresql-server-dev-11</div>
-
- The build process will attempt to use the first path in the PATH environment variable when installing AGE.
- If the <span class="inline-code">pg_config</span> path if located there, run the following
- command in the source code directory of Apache AGE to build and install the extension.
-
- <div class="code">$ make install</div>
-
- If the path to your Postgres installation is not in the PATH variable, add the path in the arguments:
-
- <div class="code">$ make PG_CONFIG=/path/to/postgres/bin/pg_config install</div>
-
- Since Apache AGE will be installed in the directory of the PostgreSQL installation, proper permissions on the directory are required. Run the following statements in
- psql to create and load age in PostgreSQL.
-
- <div class="code">=# CREATE EXTENSION age; -- run this statement only once
-CREATE EXTENSION
-=# LOAD 'age';
-LOAD
-=# SET search_path = ag_catalog, "$user", public;
-SET
- </div>
- </div>
- </div>
- <div class="main-item" id="main-gettingstarted">
- <div class="heading"><h1>Getting Started</h1></div>
- <div class="main-body">
- <div class="heading"><h2>Loading AGE</h2></div>
- Connect to your containerized Postgres instance and then run the following commands:
-
- <div class="code">
-CREATE EXTENSION age;
-LOAD 'age';
-SET search_path = ag_catalog, "$user", public;
- </div>
-
- <div class="heading"><h2>Using AGE</h2></div>
- First you will need to create a graph:
-
- <div class="code">
-SELECT create_graph('my_graph_name');
- </div>
-
- To execute Cypher queries, you will need to wrap them in the following syntax:
-
- <div class="code">
-SELECT * from cypher('my_graph_name', $$
- CypherQuery
-$$) as (a agtype);
- </div>
-
- For example, if we wanted to create a graph with 4 nodes, we could do something as shown below:
-
- <div class="code">
-SELECT * from cypher('my_graph_name', $$
- CREATE (a:Part {part_num: '123'}),
- (b:Part {part_num: '345'}),
- (c:Part {part_num: '456'}),
- (d:Part {part_num: '789'})
-$$) as (a agtype);
-
---- RESULTS
-a
----
-(0 rows)
- </div>
-
- Then we could query the graph with the following:
-
- <div class="code">
-SELECT * from cypher('my_graph_name', $$
- MATCH (a)
- RETURN a
-$$) as (a agtype);
-
---- RESULTS
- a
--------------------------------------------------------------------------------------
-{"id": 844424930131969, "label": "Part", "properties": {"part_num": "123"}}::vertex
-{"id": 844424930131970, "label": "Part", "properties": {"part_num": "345"}}::vertex
-{"id": 844424930131971, "label": "Part", "properties": {"part_num": "456"}}::vertex
-{"id": 844424930131972, "label": "Part", "properties": {"part_num": "789"}}::vertex
-(4 rows)
- </div>
-
- Next, we could create a relationship between a couple of nodes:
-
- <div class="code">
-SELECT * from cypher('my_graph_name', $$
- MATCH (a:Part {part_num: '123'}), (b:Part {part_num: '345'})
- CREATE (a)-[u:used_by { quantity: 1 }]->(b)
-$$) as (a agtype);
-
---- RESULTS
-a
----
-(0 rows)
- </div>
-
- Next we can return the path we just created (results have been formatted for readability):
-
- <div class="code">
-SELECT * from cypher('age', $$
- MATCH p=(a)-[]-(b)
- RETURN p
-$$) as (a agtype);
-
-// RESULTS
-// ROW 1
-[
- {
- "id":844424930131969,
- "label":"Part",
- "properties":{
- "part_num":"123"
- }
- }::"vertex",
- {
- "id":1125899906842625,
- "label":"used_by",
- "end_id":844424930131970,
- "start_id":844424930131969,
- "properties":{
- "quantity":1
- }
- }::"edge",
- {
- "id":844424930131970,
- "label":"Part",
- "properties":{
- "part_num":"345"
- }
- }::"vertex"
-]::"path"
-// ROW 2
-[
- {
- "id":844424930131970,
- "label":"Part",
- "properties":{
- "part_num":"345"
- }
- }::"vertex",
- {
- "id":1125899906842625,
- "label":"used_by",
- "end_id":844424930131970,
- "start_id":844424930131969,
- "properties":{
- "quantity":1
- }
- }::"edge",
- {
- "id":844424930131969,
- "label":"Part",
- "properties":{
- "part_num":"123"
- }
- }::"vertex"
-]::"path"
-(2 rows)
- </div>
-
- </div>
- </div>
-<!--
- <div class="main-item" id="main-ageworks">
- <div class="heading"><h1>How AGE Works</h1></div>
- <div class="main-body">
- Here is the brief overview of the AGE architecture in which some are related to the PostgreSQL architecture and backend.
- Every component runs on the PostgreSQL transaction cache layer and storage layer.
- <img src="assets/images/ageworks.png">
- </div>
- </div> -->
-
<!--
*
* CONTRIBUTION