Talks about: <a class="post-tag post-tag-frontmatter" href="/tags/frontmatter">frontmatter</a>, and <a class="post-tag post-tag-sql" href="/tags/sql">sql</a>

The description for the SQL statement

Configuration Options

Option: ‘Some random description’

In case you use the description option, YoSQL will use the supplied value as a JavaDoc comment

package com.example.persistence;

public class SomeRepository {

     * Some random description
    public void someMethod() {
        // ... some code

    // ... rest of generated code


Front Matter

In order to configure this option, place the following code in the front matter of your SQL statement:

-- description: configValue
SELECT  something
FROM    your_database_schema
WHERE   some_column = :some_value