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: 23 days 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 (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T23:15:25.000Z (6 months ago)
- Last Synced: 2024-10-30T00:47:29.652Z (6 months ago)
- Topics: ion, json, kotlin, partiql, sql
- Language: Kotlin
- Homepage: https://partiql.org/
- Size: 15.2 MB
- Stars: 539
- Watchers: 21
- Forks: 61
- Open Issues: 314
-
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)
[](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-specification]: https://partiql.org/assets/PartiQL-Specification.pdf
[partiql-website]: https://www.partiql.org
[partiql-website-plk]: https://partiql.org/plk/1.0/
[partiql-tests]: https://github.com/partiql/partiql-tests
[plk-releases]: https://github.com/partiql/partiql-lang-kotlin/releases
[maven-partiql-namespace]: https://central.sonatype.com/namespace/org.partiql
[git-submodule]: https://git-scm.com/book/en/v2/Git-Tools-Submodules
# PartiQL Lang Kotlin
This is a Kotlin/JVM implementation of the [PartiQL specification][partiql-specification].
PartiQL is based on SQL:1999 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 SQL.
## About
Check out the [PartiQL website][partiql-website] for documentation, usage guides, and more!
## Status
Users of PartiQL should consider the PartiQL library to be stable. It has been leveraged within a number of Amazon internal
systems and AWS products for multiple years. The behavior of the language itself is mostly stable.
## Using In Your Project
All [releases][plk-releases] are published to [Maven Central][maven-partiql-namespace]. For the most up-to-date version
of our library, please add the following to your `build.gradle.kts`.
```kotlin
dependencies {
implementation("org.partiql:partiql-lang:1.+")
}
```
For more information on how to integrate this library (or a specific subproject) into your project, please follow the
guidelines on the [partiql-lang-kotlin documentation site][partiql-website-plk] under the [PartiQL website][partiql-website].
## Building
**Pre-requisite**: Building this project requires Java 11+.
This project uses a [git submodule][git-submodule] to pull in
[partiql-tests][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 assemble
```
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
├── lib
│ └── sprout IR codegen
├── partiql-ast PartiQL ast data structures and utilities
├── partiql-cli CLI & Shell application
├── partiql-coverage Code coverage library
├── partiql-eval PartiQL compiler
├── partiql-lang Top-level project depending on all subprojects
├── partiql-parser PartiQL parser
├── partiql-plan PartiQL plan data structures and utilities
├── partiql-planner PartiQL planner
├── partiql-spi Common interfaces: types, values, catalogs, functions, etc.
└── test
├── partiql-tests Conformance test data
└── partiql-tests-runner Conformance test runner
```
## 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.