README.md

Ballerina Persist - Redis Library

This library provides Redis database support for the bal persist feature, which provides functionality to store and query data conveniently through a data model.

The persist command will make it easy to enable bal persist feature in a Ballerina project. With this support, users need not worry about the persistence in a project. Users can define an entity data model, validate the model and generate persist clients for Redis, which provide convenient APIs to store and query data in a data store.

Issues and projects

Issues and Projects tabs are disabled for this repository as this is part of the Ballerina library. To report bugs, request new features, start new discussions, view project boards, etc. please visit Ballerina library parent repository.

This repository only contains the source code for the package.

Building from the source

Set up the prerequisites

1. Download and install Java SE Development Kit (JDK) version 17 (from one of the following locations).

   • Oracle
   • OpenJDK

2. Download and install Docker

3. Export your GitHub personal access token with the read package permissions as follows.

    export packageUser=<Username>
    export packagePAT=<Personal access token>
   

Building the source

Execute the commands below to build from source.

1. To build the library:

    ./gradlew clean build
   

2. To run the integration tests:

    ./gradlew clean test
   

3. To build the package without the tests:

    ./gradlew clean build -x test
   

4. To run only specific tests:

    ./gradlew clean build -Pgroups=<Comma separated groups/test cases>
   

5. To disable some specific test groups:

    ./gradlew clean build -Pdisable-groups=<Comma separated groups/test cases>
   

6. To debug the tests:

    ./gradlew clean build -Pdebug=<port>
    ./gradlew clean test -Pdebug=<port>
   

7. To debug the package with Ballerina language:

    ./gradlew clean build -PbalJavaDebug=<port>
    ./gradlew clean test -PbalJavaDebug=<port>
   

8. Publish ZIP artifact to the local .m2 repository:

    ./gradlew clean build publishToMavenLocal
   

9. Publish the generated artifacts to the local Ballerina central repository:

    ./gradlew clean build -PpublishToLocalCentral=true
   

10. Publish the generated artifacts to the Ballerina central repository:

    ./gradlew clean build -PpublishToCentral=true
    

Contributing to Ballerina

As an open source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All contributors are encouraged to read the Ballerina code of conduct.

Useful links

• Chat live with us via our Discord server.
• Post all technical questions on Stack Overflow with the #ballerina tag.