io.kestra.plugin.jdbc.JdbcQueryInterface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of plugin-jdbc Show documentation

Abstract JDBC plugin for Kestra

There is a newer version: 0.19.1

package io.kestra.plugin.jdbc;

import io.kestra.core.models.annotations.PluginProperty;
import io.swagger.v3.oas.annotations.media.Schema;


public interface JdbcQueryInterface extends JdbcStatementInterface {
    @Schema(
        title = "The sql query to run"
    )
    @PluginProperty(dynamic = true)
    String getSql();

    @Schema(
        title = "Whether to fetch the data from the query result to the task output" +
            " This parameter is evaluated after 'fetchOne' and 'store'."
    )
    @PluginProperty(dynamic = false)
    boolean isFetch();

    @Schema(
        title = "Whether to fetch data row from the query result to a file in internal storage." +
            " File will be saved as Amazon Ion (text format)." +
            " \n" +
            " See Amazon Ion documentation" +
            " This parameter is evaluated after 'fetchOne' but before 'fetch'."
    )
    @PluginProperty(dynamic = false)
    boolean isStore();

    @Schema(
        title = "Whether to fetch only one data row from the query result to the task output." +
            " This parameter is evaluated before 'store' and 'fetch'."
    )
    @PluginProperty(dynamic = false)
    boolean isFetchOne();

    @Schema(
        title = "Number of rows that should be fetched",
        description = "Gives the JDBC driver a hint as to the number of rows that should be fetched from the database " +
            "when more rows are needed for this ResultSet object. If the fetch size specified is zero, the JDBC driver " +
            "ignores the value and is free to make its own best guess as to what the fetch size should be. Ignored if " +
            "`autoCommit` is false."
    )
    @PluginProperty(dynamic = false)
    Integer getFetchSize();
}