Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/partiql/partiql-lang-kotlin
PartiQL libraries and tools in Kotlin.
https://github.com/partiql/partiql-lang-kotlin
ion json kotlin partiql sql
Last synced: 3 months ago
JSON representation
PartiQL libraries and tools in Kotlin.
- Host: GitHub
- URL: https://github.com/partiql/partiql-lang-kotlin
- Owner: partiql
- License: apache-2.0
- Created: 2019-05-13T18:28:06.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-18T20:07:40.000Z (3 months ago)
- Last Synced: 2024-10-19T12:55:06.396Z (3 months ago)
- Topics: ion, json, kotlin, partiql, sql
- Language: Kotlin
- Homepage: https://partiql.org/
- Size: 14.5 MB
- Stars: 539
- Watchers: 21
- Forks: 60
- Open Issues: 311
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - partiql-lang-kotlin - A implementation of PartiQL written in Kotlin. (Kotlin)
- awesome-repositories - partiql/partiql-lang-kotlin - PartiQL libraries and tools in Kotlin. (Kotlin)
README
[](https://maven-badges.herokuapp.com/maven-central/org.partiql/partiql-lang-kotlin)
[](https://github.com/partiql/partiql-lang-kotlin/blob/main/LICENSE)
[](https://github.com/partiql/partiql-lang-kotlin/actions?query=workflow%3A%22Build+and+Report+Generation%22)
[](https://codecov.io/gh/partiql/partiql-lang-kotlin)
# PartiQL Lang Kotlin
This is a Kotlin implementation of the [PartiQL specification](https://partiql.org/assets/PartiQL-Specification.pdf).
PartiQL is based on SQL-99 and has added support for working with schemaless hierarchical data.
PartiQL’s extensions to SQL are easy to understand, treat nested data as first class citizens and
compose seamlessly with each other and SQL.
This repository contains an embeddable reference interpreter, test framework, and tests for PartiQL in Kotlin.
## About
Check out the [PartiQL Lang Kotlin Wiki](https://github.com/partiql/partiql-lang-kotlin/wiki) for documentation,
tutorials, upgrade guides, and more!
## Status
Users of PartiQL should consider PartiQL to be in "preview" status. It has been leveraged within a number of Amazon internal
systems and AWS products for over a year. The behavior of the language itself is mostly stable, however,
the public API of the interpreter is slated to undergo significant improvements in the near term. (See the
GitHub issues list for details.)
## Using In Your Project
This project is published to [Maven Central](https://search.maven.org/artifact/org.partiql/partiql-lang-kotlin).
| Group ID | Artifact ID | Recommended Version |
|---------------|-----------------------|---------------------|
| `org.partiql` | `partiql-lang-kotlin` | `0.14.5` |
For Maven builds, add the following to your `pom.xml`:
```xml
org.partiql
partiql-lang-kotlin
${version}
```
For Gradle 5+, add the following to your `build.gradle`:
```groovy
repositories {
mavenCentral()
}
dependencies {
implementation "org.partiql:partiql-lang-kotlin:${version}"
}
```
Be sure to replace `${version}` with the desired version.
## Building
**Pre-requisite**: Building this project requires Java 11+.
This project uses a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to pull in
[partiql-tests](https://github.com/partiql/partiql-tests). The easiest way to pull everything in is to clone the
repository recursively:
```bash
$ git clone --recursive https://github.com/partiql/partiql-lang-kotlin.git
```
You can also initialize the submodules as follows:
```bash
$ git submodule update --init --recursive
```
To build this project, from the root directory execute:
```shell
./gradlew build
```
This will build the reference interpreter and test framework, then run all unit and integration tests.
## Directory Structure
```
$ tree -d -L 2 -I build -I src`
.
├── buildSrc Gradle multi-project build
├── docs Documentation
│ ├── upgrades
│ └── wiki
├── examples Code examples
├── lib
│ ├── isl Ion Schema DOM
│ └── sprout IR codegen
├── partiql-ast PartiQL ast data structures and utilities
├── partiql-cli CLI & Shell application
├── partiql-coverage Code coverage library
├── partiql-lang Top-level project containing all subprojects
├── partiql-parser PartiQL parser
├── partiql-plan PartiQL plan data structures and utilities
├── partiql-planner PartiQL planner
├── partiql-spi Service provider interface
├── partiql-types PartiQL types
├── plugins PartiQL plugins used in testing
│ ├── partiql-local
│ └── partiql-memory
└── test
├── partiql-tests Conformance test data
└── partiql-tests-runner Conformance test runner
```
### Running JMH Benchmarks
To run JMH benchmarks located in `lang/jmh`, build the entire project first and then run
the following command:
```shell
./gradlew jmh
```
### Examples
See the [examples](examples) project in this repository for examples covering
use of the PartiQL interpreter in your project.
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md)
## License
The works contained within this repository are licensed under the Apache 2.0 License.
See the [LICENSE](LICENSE) file.