This is an automated email from the ASF dual-hosted git repository.
rafsun42 pushed a commit to branch PG13
in repository https://gitbox.apache.org/repos/asf/age.git
The following commit(s) were added to refs/heads/PG13 by this push:
new 60854371 Updated Readme.md with new discord link (#1263)
60854371 is described below
commit 608543710c78ac97f0af422523906c449368b9e0
Author: Hassam <[email protected]>
AuthorDate: Fri Oct 6 22:55:36 2023 +0500
Updated Readme.md with new discord link (#1263)
---
README.md | 95 +++++++++++++++++++++++++--------------------------------------
1 file changed, 38 insertions(+), 57 deletions(-)
diff --git a/README.md b/README.md
index 83b34cd9..26fc400f 100644
--- a/README.md
+++ b/README.md
@@ -19,11 +19,8 @@
<br>
-
</br>
-
-
<p align="center">
<a href="https://github.com/apache/age/blob/master/LICENSE";>
<img src="https://img.shields.io/github/license/apache/age"/>
@@ -49,16 +46,15 @@
<img src="https://img.shields.io/github/stars/apache/age"/>
</a>
- <a href="https://discord.gg/NMsBs9X8Ss";>
+ <a href="https://discord.com/invite/r7Y7us2Nqh";>
<img
src="https://img.shields.io/discord/1022177873127280680.svg?label=discord&style=flat&color=5a66f6";></a>
</p>
<br>
-
<h2><img height="30" src="/img/AGE.png"> What is Apache AGE?</h2>
-[Apache AGE](https://age.apache.org/#) is an extension for PostgreSQL that
enables users to leverage a graph database on top of the existing relational
databases. AGE is an acronym for A Graph Extension and is inspired by Bitnine's
AgensGraph, a multi-model database fork of PostgreSQL. The basic principle of
the project is to create a single storage that handles both the relational and
graph data model so that the users can use the standard ANSI SQL along with
openCypher, one of the most [...]
+[Apache AGE](https://age.apache.org/#) is an extension for PostgreSQL that
enables users to leverage a graph database on top of the existing relational
databases. AGE is an acronym for A Graph Extension and is inspired by Bitnine's
AgensGraph, a multi-model database fork of PostgreSQL. The basic principle of
the project is to create a single storage that handles both the relational and
graph data model so that the users can use the standard ANSI SQL along with
openCypher, one of the most [...]
</br>
</br>
</br>
@@ -69,14 +65,13 @@
</br>
-Since AGE is based on the powerful PostgreSQL RDBMS, it is robust and fully
featured. AGE is optimized for handling complex connected graph data. It
provides plenty of robust database features essential to the database
environment, including ACID transactions, multi-version concurrency control
(MVCC), stored procedure, triggers, constraints, sophisticated monitoring, and
a flexible data model (JSON). Users with a relational database background who
require graph data analytics can use thi [...]
+Since AGE is based on the powerful PostgreSQL RDBMS, it is robust and fully
featured. AGE is optimized for handling complex connected graph data. It
provides plenty of robust database features essential to the database
environment, including ACID transactions, multi-version concurrency control
(MVCC), stored procedure, triggers, constraints, sophisticated monitoring, and
a flexible data model (JSON). Users with a relational database background who
require graph data analytics can use thi [...]
There is a strong need for cohesive, easy-to-implement multi-model databases.
As an extension of PostgreSQL, AGE supports all the functionalities and
features of PostgreSQL while also offering a graph model to boot.
-
<h2><img height="30" src="/img/tick.svg"> Overview</h2>
-Apache AGE is :
+Apache AGE is :
- **Powerful**: adds graph database support to the already popular PostgreSQL
database: PostgreSQL is used by organizations including Apple, Spotify, and
NASA.
- **Flexible**: allows you to perform openCypher queries, which makes complex
queries much easier to write. It also enables querying multiple graphs at the
same time.
@@ -98,41 +93,42 @@ Apache AGE is :
- **Property Indexes**: on both vertices(nodes) and edges
- **Full PostgreSQL**: supports PG features
-
-
<h2><img height="30"
src="/img/documentation.svg"> Documentation</h2>
-Refer to our latest [Apache AGE
documentation](https://age.apache.org/age-manual/master/index.html) to learn
about installation, features, built-in functions, and Cypher queries.
-
-
+Refer to our latest [Apache AGE
documentation](https://age.apache.org/age-manual/master/index.html) to learn
about installation, features, built-in functions, and Cypher queries.
<h2><img height="30"
src="/img/installation.svg"> Pre-Installation</h2>
Install the following essential libraries according to each OS. Building AGE
from the source depends on the following Linux libraries (Ubuntu package names
shown below):
- **CentOS**
+
```bash
yum install gcc glibc glib-common readline readline-devel zlib zlib-devel flex
bison
```
+
- **Fedora**
+
```bash
dnf install gcc glibc bison flex readline readline-devel zlib zlib-devel
```
+
- **Ubuntu**
+
```bash
sudo apt-get install build-essential libreadline-dev zlib1g-dev flex bison
```
<h2><img height="30" src="/img/installation.svg"> Installation</h2>
-Apache AGE is intended to be simple to install and run. It can be installed
with Docker and other traditional ways.
+Apache AGE is intended to be simple to install and run. It can be installed
with Docker and other traditional ways.
<h4><a><img width="20" src="/img/pg.svg"></a>
Install PostgreSQL
</h4>
You will need to install an AGE compatible version of Postgres<a>, for now AGE
supports Postgres 11, 12, 13, 14 & 15. Supporting the latest versions is on AGE
roadmap.
-
+
<h4>
Installation via Package Manager
</h4>
@@ -142,17 +138,16 @@ You can use a <a
href="https://www.postgresql.org/download/";>package management
<br>
```bash
-sudo apt install postgresql
+sudo apt install postgresql
```
+
<h4>
Installation From Source Code
</h4>
You can <a href="https://www.postgresql.org/ftp/source/";> download the
Postgres </a> source code and install your own instance of Postgres. You can
read instructions on how to install from source code for different versions on
the <a href="https://www.postgresql.org/docs/13/installation.html";>official
Postgres Website.</a>
-
-
<h4><img width="20" src="/img/tux.svg"><img width="20" src="/img/apple.svg">
Install AGE on Linux and MacOS
</h4>
@@ -160,22 +155,23 @@ Clone the <a href="https://github.com/apache/age";>github
repository</a> or downl
</a>
Run the pg_config utility and check the version of PostgreSQL. Currently, only
PostgreSQL versions 11, 12, 13, 14 & 15 are supported. If you have any other
version of Postgres, you will need to install PostgreSQL version 11, 12, 13,
14, or 15.
<br>
-
+
```bash
pg_config
```
-Run the following command in the source code directory of Apache AGE to build
and install the extension.
-
+
+Run the following command in the source code directory of Apache AGE to build
and install the extension.
+
```bash
make install
```
-
+
If the path to your Postgres installation is not in the PATH variable, add the
path in the arguments:
+
```bash
make PG_CONFIG=/path/to/postgres/bin/pg_config install
```
-
<h4></a><img width="30" src="/img/docker.svg"></a>
Run using Docker
</h4>
@@ -186,6 +182,7 @@ make PG_CONFIG=/path/to/postgres/bin/pg_config install
docker pull apache/age
```
+
<h5> Create AGE docker container </h5>
```bash
@@ -199,8 +196,6 @@ docker run \
apache/age
```
-
-
<h2><img height="20" src="/img/contents.svg"> Post Installation</h2>
For every connection of AGE you start, you will need to load the AGE extension.
@@ -208,15 +203,15 @@ For every connection of AGE you start, you will need to
load the AGE extension.
```bash
CREATE EXTENSION age;
```
+
```bash
LOAD 'age';
```
+
```bash
SET search_path = ag_catalog, "$user", public;
```
-
-
<h2><img height="20" src="/img/contents.svg"> Quick Start</h2>
To create a graph, use the create_graph function located in the ag_catalog
namespace.
@@ -225,20 +220,19 @@ To create a graph, use the create_graph function located
in the ag_catalog names
SELECT create_graph('graph_name');
```
-To create a single vertex, use the CREATE clause.
+To create a single vertex, use the CREATE clause.
```bash
-SELECT *
+SELECT *
FROM cypher('graph_name', $$
CREATE (n)
$$) as (v agtype);
```
-
-To create a single vertex with the label, use the CREATE clause.
+To create a single vertex with the label, use the CREATE clause.
```bash
-SELECT *
+SELECT *
FROM cypher('graph_name', $$
CREATE (:label)
$$) as (v agtype);
@@ -247,26 +241,26 @@ $$) as (v agtype);
To create a single vertex with label and properties, use the CREATE clause.
```bash
-SELECT *
+SELECT *
FROM cypher('graph_name', $$
CREATE (:label {property:value})
$$) as (v agtype);
```
-To query the graph, you can use the MATCH clause.
+To query the graph, you can use the MATCH clause.
```bash
-SELECT *
+SELECT *
FROM cypher('graph_name', $$
MATCH (v)
RETURN v
$$) as (v agtype);
```
-You can use the following to create an edge, for example, between two nodes.
+You can use the following to create an edge, for example, between two nodes.
```bash
-SELECT *
+SELECT *
FROM cypher('graph_name', $$
MATCH (a:label), (b:label)
WHERE a.property = 'Node A' AND b.property = 'Node B'
@@ -275,11 +269,10 @@ FROM cypher('graph_name', $$
$$) as (e agtype);
```
-
To create an edge and set properties.
```bash
-SELECT *
+SELECT *
FROM cypher('graph_name', $$
MATCH (a:label), (b:label)
WHERE a.property = 'Node A' AND b.property = 'Node B'
@@ -288,10 +281,10 @@ FROM cypher('graph_name', $$
$$) as (e agtype);
```
-Example
+Example
```bash
-SELECT *
+SELECT *
FROM cypher('graph_name', $$
MATCH (a:Person), (b:Person)
WHERE a.name = 'Node A' AND b.name = 'Node B'
@@ -300,8 +293,6 @@ FROM cypher('graph_name', $$
$$) as (e agtype);
```
-
-
<h2><img height="20" src="/img/gettingstarted.svg"> Language
Specific Drivers</h2>
Starting with Apache AGE is very simple. You can easily select your platform
and incorporate the relevant SDK into your code.
@@ -312,7 +303,6 @@ Starting with Apache AGE is very simple. You can easily
select your platform and
<img src="/img/age-02.png" width="80%" height="80%">
</p>
-
<h4>Built-in</h4>
- [Go driver](./drivers/golang)
@@ -324,24 +314,19 @@ Starting with Apache AGE is very simple. You can easily
select your platform and
- [Apache AGE Rust Driver](https://github.com/Dzordzu/rust-apache-age.git)
-
-
-
<h2><img height="20" src="/img/contributing.svg"> Community</h2>
-Join the AGE community for help, questions, discussions, and contributions.
+Join the AGE community for help, questions, discussions, and contributions.
- Check our [website](https://age.apache.org/)
-- Join the Live Chat on [Discord](https://discord.com/invite/NMsBs9X8Ss/)
+- Join the Live Chat on [Discord](https://discord.com/invite/r7Y7us2Nqh)
- Follow us on
[Twitter](https://twitter.com/apache_age?s=20&t=7Hu8Txk4vjvuEp-ryakacg)
- Subscribe to our developer mailing list by sending an email to
[email protected]
- Subscribe to our user mailing list by sending an email to
[email protected]
- Subscribe to our committer mailing list (To become a committer) by sending
an email to [email protected]
-
<h2><img height="20" src="/img/visualization.svg"> Graph
Visualization Tool for AGE</h2>
-
Apache AGE Viewer is a user interface for Apache AGE that provides
visualization and exploration of data.
This web visualization tool allows users to enter complex graph queries and
explore the results in graph and table forms.
Apache AGE Viewer is enhanced to proceed with extensive graph data and
discover insights through various graph algorithms.
@@ -350,19 +335,15 @@ Apache AGE Viewer will become a graph data administration
and development platfo
**This is a visualization tool.**
After installing AGE Extension, you may use this tool to get access to the
visualization features.
-
-
<h2><img height="20" src="/img/videos.png"> Video Links</h2>
-You can also get help from these videos.
+You can also get help from these videos.
- Install on
[Windows](https://www.youtube.com/watch?v=ddk8VX8Hm-I&list=PLGp3huJbWNDjgwP7s99Q-9_w1vxpjNHXG)
- Install on [MacOS](https://www.youtube.com/watch?v=0-qMwpDh0CA)
-
-
<h2><img height="20" src="/img/community.svg"> Contributing</h2>
You can improve ongoing efforts or initiate new ones by sending pull requests
to [this repository](https://github.com/apache/age).
![https://img.shields.io/discord/1022177873127280680.svg?label=discord&style=flat&color=5a66f6"](https://img.shields.io/discord/1022177873127280680.svg?label=discord&style=flat&color=5a66f6"){kind=link}