Class SqlStatements

java.lang.Object
org.jdbi.v3.core.statement.SqlStatements
All Implemented Interfaces:
JdbiConfig<SqlStatements>
public final class SqlStatements extends Object implements JdbiConfig<SqlStatements>
Configuration holder for SqlStatements.

  • Field Details

    • SQL_TEMPLATE_CACHE_SIZE

      public static final int SQL_TEMPLATE_CACHE_SIZE
      The default size of the SQL template cache.
      See Also:

  • Constructor Details

    • SqlStatements

      public SqlStatements()

  • Method Details

    • define

      public SqlStatements define(String key, Object value)
      Define an attribute for StatementContext for statements executed by Jdbi.
      Parameters:
      key - the key for the attribute
      value - the value for the attribute
      Returns:
      this

    • defineMap

      public SqlStatements defineMap(Map<String,?> values)
      Defines attributes for each key/value pair in the Map.
      Parameters:
      values - map of attributes to define.
      Returns:
      this

    • getAttribute

      public Object getAttribute(String key)
      Obtain the value of an attribute
      Parameters:
      key - the name of the attribute
      Returns:
      the value of the attribute

    • getAttributes

      public Map<String,Object> getAttributes()
      Returns the attributes which will be applied to SQL statements created by Jdbi.
      Returns:
      the defined attributes.

    • addCustomizer

      public SqlStatements addCustomizer(StatementCustomizer customizer)
      Provides a means for custom statement modification. Common customizations have their own methods, such as Query.setMaxRows(int)
      Parameters:
      customizer - instance to be used to customize a statement
      Returns:
      this

    • addContextListener

      public SqlStatements addContextListener(StatementContextListener listener)

    • getTemplateEngine

      public TemplateEngine getTemplateEngine()
      Returns the TemplateEngine which renders the SQL template.
      Returns:
      the template engine which renders the SQL template prior to parsing parameters.

    • setTemplateEngine

      public SqlStatements setTemplateEngine(TemplateEngine templateEngine)
      Sets the TemplateEngine used to render SQL for all SQL statements executed by Jdbi. The default engine replaces <name>-style tokens with attributes defined on the statement context.
      Parameters:
      templateEngine - the new template engine.
      Returns:
      this

    • setTemplateCache

      @Beta public SqlStatements setTemplateCache(JdbiCacheBuilder cacheBuilder)
      Sets the cache used to avoid repeatedly parsing SQL statements.
      Parameters:
      cacheBuilder - the cache builder to use to create the cache.
      Returns:
      this

    • getSqlParser

      public SqlParser getSqlParser()

    • setSqlParser

      public SqlStatements setSqlParser(SqlParser sqlParser)
      Sets the SqlParser used to parse parameters in SQL statements executed by Jdbi. The default parses colon-prefixed named parameter tokens, e.g. :name.
      Parameters:
      sqlParser - the new SQL parser.
      Returns:
      this

    • getTimingCollector

      @Deprecated(since="3.2.0", forRemoval=true) public TimingCollector getTimingCollector()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use getSqlLogger() instead
      Returns:
      the timing collector

    • setTimingCollector

      @Deprecated(since="3.2.0", forRemoval=true) public SqlStatements setTimingCollector(TimingCollector timingCollector)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use setSqlLogger(SqlLogger) instead
      Sets the TimingCollector used to collect timing about the SQL statements executed by Jdbi. The default collector does nothing.
      Parameters:
      timingCollector - the new timing collector
      Returns:
      this

    • getSqlLogger

      public SqlLogger getSqlLogger()
      Returns the current logger.
      Returns:
      A SqlLogger instance

    • setSqlLogger

      public SqlStatements setSqlLogger(SqlLogger sqlLogger)
      Sets a SqlLogger instance to log all SQL operations.
      Parameters:
      sqlLogger - The logger. Using null turns off all logging
      Returns:
      this

    • getQueryTimeout

      @Beta public Integer getQueryTimeout()

    • setQueryTimeout

      @Beta public SqlStatements setQueryTimeout(@Nullable Integer seconds)
      Jdbi does not implement its own timeout mechanism: it simply calls Statement.setQueryTimeout(int), leaving timeout handling to your jdbc driver.
      Parameters:
      seconds - the time in seconds to wait for a query to complete; 0 to disable the timeout; null to leave it at defaults (i.e. Jdbi will not call setQueryTimeout(int))
      Returns:
      this

    • isUnusedBindingAllowed

      public boolean isUnusedBindingAllowed()

    • setUnusedBindingAllowed

      public SqlStatements setUnusedBindingAllowed(boolean unusedBindingAllowed)
      Sets whether or not an exception should be thrown when any arguments are given to a query but not actually used in it. Unused bindings tend to be bugs or oversights, but are not always. Defaults to false: unused bindings are not allowed.
      Parameters:
      unusedBindingAllowed - the new setting
      Returns:
      this
      See Also:

    • isAttachAllStatementsForCleanup

      public boolean isAttachAllStatementsForCleanup()
      If true, all statements created within Jdbi.withHandle(HandleCallback), Jdbi.useHandle(HandleConsumer), Jdbi.inTransaction(HandleCallback) and Jdbi.useTransaction(HandleConsumer) are attached to the Handle object for cleanup.
      Returns:
      True if statements are attached to their handle for cleanup
      Since:
      3.38.0

    • setAttachAllStatementsForCleanup

      @Beta public void setAttachAllStatementsForCleanup(boolean attachAllStatementsForCleanup)
      Sets whether all statements created will automatically attached to the corresponding Handle object automatically. This can be useful when mostly short-lived handles are used because closing the handle will now clean up all outstanding resources from any statement. The default is false.
      Parameters:
      attachAllStatementsForCleanup - If true, all statements are automatically attached to the Handle
      Since:
      3.38.0

    • isAttachCallbackStatementsForCleanup

      public boolean isAttachCallbackStatementsForCleanup()
      If true, statements created within Jdbi.withHandle(HandleCallback), Jdbi.useHandle(HandleConsumer), Jdbi.inTransaction(HandleCallback) and Jdbi.useTransaction(HandleConsumer) will be attached to the Handle object in the callback for cleanup.
      Returns:
      True if statements are attached to their handle within Jdbi callbacks
      Since:
      3.38.0

    • setScriptStatementsNeedSemicolon

      public void setScriptStatementsNeedSemicolon(boolean scriptStatementsNeedSemicolon)
      If true, script statements parsed by a Script object will have a trailing semicolon. Some databases (e.g. Oracle) require that trailing semicolon while others (e.g. MySQL) do not and may consider it a syntax error. If executing a script against the database results in syntax errors that point at semicolons, change the value of this setting.
      The default setting is true for historical reasons.
      Parameters:
      scriptStatementsNeedSemicolon - If true, parsed statements will have a trailing semicolon.
      Since:
      3.43.0

    • isScriptStatementsNeedSemicolon

      public boolean isScriptStatementsNeedSemicolon()
      If true, script statements parsed by a Script object will have a trailing semicolon. Some databases (e.g. Oracle) require that trailing semicolon while others (e.g. MySQL) do not and may consider it a syntax error. If executing a script against the database results in syntax errors that point at semicolons, change the value of this setting.
      Returns:
      True if parsed statements will have a trailing semicolon.
      Since:
      3.43.0

    • setAttachCallbackStatementsForCleanup

      public void setAttachCallbackStatementsForCleanup(boolean attachCallbackStatementsForCleanup)
      Sets whether statements created within the Jdbi.withHandle(HandleCallback), Jdbi.useHandle(HandleConsumer), Jdbi.inTransaction(HandleCallback) and Jdbi.useTransaction(HandleConsumer) callback methods will automatically attached to the Handle object and therefore cleaned up when the callback ends. The default is true.
      Parameters:
      attachCallbackStatementsForCleanup - If true, statements created within the Jdbi callbacks are attached to the handle
      Since:
      3.38.0

    • setJfrSqlMaxLength

      @Beta public SqlStatements setJfrSqlMaxLength(int jfrSqlMaxLength)
      When recording JFR events, the maximum length of rendered SQL to store in the event record.

    • getJfrSqlMaxLength

      @Beta public int getJfrSqlMaxLength()
      When recording JFR events, the maximum length of rendered SQL to store in the event record.

    • setJfrParamMaxLength

      @Beta public SqlStatements setJfrParamMaxLength(int jfrParamMaxLength)
      When recording JFR events, the maximum length of rendered parameters to store in the event record.

    • getJfrParamMaxLength

      @Beta public int getJfrParamMaxLength()
      When recording JFR events, the maximum length of rendered parameters to store in the event record.

    • cacheStats

      @Beta public <T> T cacheStats()
      Returns cache statistics for the internal template cache. This returns a cache specific object, so the user needs to know what caching library is in use.
      Type Parameters:
      T - the type of the cache statistics object

    • createCopy

      public SqlStatements createCopy()
      Description copied from interface: JdbiConfig
      Returns a copy of this configuration object. Changes to the copy should not modify the original, and vice-versa.
      Specified by:
      createCopy in interface JdbiConfig<SqlStatements>
      Returns:
      a copy of this configuration object.