Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lszeremeta/yarspg

YARS-PG grammar. The YARS-PG serialization is specially designed for graphs, especially property graphs.
https://github.com/lszeremeta/yarspg

antlr antlr-grammar antlr4 antlr4-grammar databases grammar grammar-checker grammar-parser graph graph-database graph-databases graph-serialization property-graph serialization yars yars-pg yars-pg-grammar yarspg

Last synced: 11 days ago
JSON representation

YARS-PG grammar. The YARS-PG serialization is specially designed for graphs, especially property graphs.

Host: GitHub
URL: https://github.com/lszeremeta/yarspg
Owner: lszeremeta
License: bsd-3-clause
Created: 2018-12-11T15:08:40.000Z (about 6 years ago)
Default Branch: main
Last Pushed: 2024-12-09T22:42:51.000Z (24 days ago)
Last Synced: 2024-12-09T23:31:08.260Z (24 days ago)
Topics: antlr, antlr-grammar, antlr4, antlr4-grammar, databases, grammar, grammar-checker, grammar-parser, graph, graph-database, graph-databases, graph-serialization, property-graph, serialization, yars, yars-pg, yars-pg-grammar, yarspg
Language: ANTLR
Homepage: https://ieeexplore.ieee.org/document/10536116
Size: 9.74 MB
Stars: 6
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # YARS-PG grammar

[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/lszeremeta/yarspg/pre-release.yml?label=Test%20and%20pre-release)](https://github.com/lszeremeta/yarspg/actions/workflows/pre-release.yml) [![GitHub Release](https://img.shields.io/github/v/release/lszeremeta/yarspg)](https://github.com/lszeremeta/yarspg/releases/latest) [![DOI](https://zenodo.org/badge/161351716.svg)](https://zenodo.org/badge/latestdoi/161351716)

The YARS-PG serialization is designed for property graphs (but not only):

* YARS-PG supports all the features allowed by the current database systems based on the property graph data model,

* YARS-PG provides a simple syntax with a reduced number of extra characters,

* YARS-PG is inspired by the syntax used by popular graph query languages (e.g. Cypher and GQL) to encode the structure

  of a property graph (i.e. nodes, edges, and properties).

[![YARS-PG overview](https://raw.githubusercontent.com/lszeremeta/yarspg/main/YARS-PG-overview.gif)](https://ieeexplore.ieee.org/document/10536116)

Read more about the current version of YARS-PG in the following

paper: [YARS-PG: Property Graphs Representation for Publication and Exchange](https://ieeexplore.ieee.org/document/10536116).

The YARS-PG grammar is written in [ANTLR4](https://github.com/antlr/antlr4). If you

prefer [Extended Backus-Naur Form (EBNF)](https://www.w3.org/TR/REC-xml/#sec-notation) notation, you can also

see [YARS-PG grammar in EBNF](https://github.com/lszeremeta/antlr-yarspg/blob/main/other-notations/YARSpg.ebnf).

## Examples

See [examples](https://github.com/lszeremeta/yarspg/tree/main/yarspg/examples) to get familiar with the YARS-PG syntax.

Additional examples:

* [Parts of the Mizar Mathematical Library Knowledge Graph (MMLKG) dataset (YARS-PG version)](https://figshare.com/articles/dataset/Parts_of_the_Mizar_Mathematical_Library_Knowledge_Graph_MMLKG_dataset_YARS-PG_version_/25139015)

* [Sample Knows benchmark outputs in YARS-PG](https://figshare.com/articles/dataset/Sample_Knows_benchmark_outputs_in_YARS-PG/25139189)

## Parsers

The YARS-PG parsers are available in the [parsers](https://github.com/lszeremeta/yarspg/blob/main/parsers). Currently,

there are parsers for the following languages:

* [Java](https://github.com/lszeremeta/yarspg/blob/main/parsers/java)

* [Python](https://github.com/lszeremeta/yarspg/blob/main/parsers/python)

If you want to help build YARS-PG parsers for other languages, please follow

the [ANTLR4 documentation](https://github.com/antlr/antlr4/tree/dev/doc) and create a pull request.

See the ``README.md`` file in each parser directory for more details. Ready-to-use parsers are also available in the

Assets section in [Releases](https://github.com/lszeremeta/yarspg/releases).

## Testing grammar

Run tests on files in ``yarspg/examples``:

```shell

mvn clean test

```

This project is based on the [ANTLR grammars-v4 project](https://github.com/antlr/grammars-v4).

## Contribution

Would you like to improve this project? Great! We are waiting for your help and suggestions. If you are new to open

source contributions, read [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/).

## License

Distributed under [BSD 3-Clause License](https://github.com/lszeremeta/yarspg/blob/main/LICENSE).