This part of the documentation is intended for developers looking for information on how to use the various YoSQL tools. Each currently supported tool has its own documentation page, which is listed below. We recommend using the tooling that is most appropriate for your project, e.g. Maven projects should use the YoSQL Maven tooling. Since YoSQL is not required at run-time, you could use it just once to generate code and not add YoSQL to your build at all.

In its default configuration, YoSQL will try to generate as much code as possible, and you are expected to configure the generated code so that it matches the requirements of your project. Some YoSQL tools will try to auto-detect certain settings, e.g. the Maven plugin will look at existing dependencies, and the configuration of the compiler plugin in order to create a configuration for your project automatically. Take a look at the configuration section in order to see all available configuration options in case you want to change something.

All YoSQL tools support multiple persistence and logging APIs. Try to use the same APIs that are already available in your project, in order to keep the number of dependencies as low as possible (zero).

Once your initial setup is complete, it’s time to write SQL statements. There is no upper limit imposed by YoSQL on how many statements there can be per generated repository, however Java has a hard limit of 65535 methods per class. We recommend splitting your statements according to the domain objects in your projects, e.g. all statements that are related to a single class should go in one repository, but you a free to choose whatever structure best fits your project.

Using any of the listed tools below allows you to convert SQL statements into runnable Java code that no longer requires the original SQL statements.