Context (jOOQ 3.4.5 API)

All Known Subinterfaces:

BindContext, RenderContext
```
public interface Context<C extends Context<C>>
```
A context type that is used for rendering SQL or for binding.

Author:

Lukas Eder

See Also:

BindContext, RenderContext

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BindContext`	`bindValue(Object value, Field<?> field)` Bind a value using a specific type.
`Boolean`	`cast()` Whether casting must be applied.
`RenderContext.CastMode`	`castMode()` The currently applied cast mode for bind values.
`C`	`castMode(RenderContext.CastMode mode)` Set the new cast mode for `castMode()`.
`C`	`castModeSome(SQLDialect... dialects)` Set the new cast mode to `RenderContext.CastMode.SOME` for a list of dialects.
`Configuration`	`configuration()` The configuration wrapped by this context.
`Map<Object,Object>`	`data()` Get all custom data from this `Context`.
`Object`	`data(Object key)` Get some custom data from this `Context`.
`Object`	`data(Object key, Object value)` Set some custom data to this `Context`.
`boolean`	`declareCTE()` Whether the current context is rendering a common table expression (e.g.
`C`	`declareCTE(boolean declareCTE)` Set the new context value for `declareCTE()`
`boolean`	`declareFields()` Whether the current context is rendering a SQL field declaration (e.g. a `Field` in the `SELECT` clause of the query).
`C`	`declareFields(boolean declareFields)` Set the new context value for `declareFields()`
`boolean`	`declareTables()` Whether the current context is rendering a SQL table declaration (e.g. a `Table` in the `FROM` or `JOIN` clause of the query).
`C`	`declareTables(boolean declareTables)` Set the new context value for `declareTables()`
`boolean`	`declareWindows()` Whether the current context is rendering a SQL window declaration (e.g. a `WindowDefinition` in the `WINDOW` clause of the query).
`C`	`declareWindows(boolean declareWindows)` Set the new context value for `declareWindows()`
`C`	`end(Clause clause)`
`boolean`	`format()` The value of `Settings.isRenderFormatted()`.
`C`	`format(boolean format)` Override the value of `Settings.isRenderFormatted()`.
`C`	`formatIndentEnd()` Stop indenting subsequent SQL by one level (two characters), if `Settings.isRenderFormatted()` is set to `true`.
`C`	`formatIndentEnd(int indent)` Stop indenting subsequent SQL by a number of characters, if `Settings.isRenderFormatted()` is set to `true`.
`C`	`formatIndentLockEnd()` Stop indenting subsequent SQL at the same level as the current line, if `Settings.isRenderFormatted()` is set to `true`.
`C`	`formatIndentLockStart()` Start indenting subsequent SQL at the same level as the current line, if `Settings.isRenderFormatted()` is set to `true`.
`C`	`formatIndentStart()` Start indenting subsequent SQL by one level (two characters), if `Settings.isRenderFormatted()` is set to `true`.
`C`	`formatIndentStart(int indent)` Start indenting subsequent SQL by a number of characters, if `Settings.isRenderFormatted()` is set to `true`.
`C`	`formatNewLine()` Render a new line character (only if `Settings.isRenderFormatted()` is set to `true`).
`C`	`formatNewLineAfterPrintMargin()` Render a new line character (only if `Settings.isRenderFormatted()` is set to `true`, and the `formatPrintMargin(int)` has been exceeded).
`C`	`formatPrintMargin(int margin)` Set a print margin that will be applied to formatted SQL, if `Settings.isRenderFormatted()` is set to `true`.
`C`	`formatSeparator()` Render a new line character (only if `Settings.isRenderFormatted()` is set to `true`), or a whitespace separator character otherwise.
`C`	`keyword(String keyword)` Append a SQL keyword to the context's contained `StringBuilder`.
`C`	`literal(String literal)` Append some (quoted) literal to the context's contained `StringBuilder`.
`String`	`nextAlias()` Return a new alias that is unique for the scope of one query.
`int`	`nextIndex()` Get the next bind index.
`ParamType`	`paramType()` Specify, how bind values should be rendered.
`C`	`paramType(ParamType paramType)` Set the new context value for `paramType()`.
`String`	`peekAlias()` Peek the next alias that will be generated by `nextAlias()`.
`int`	`peekIndex()` Peek the next bind index.
`boolean`	`qualify()` Whether query parts should render qualified names or not.
`C`	`qualify(boolean qualify)` Sett the new context value for `qualify()`.
`String`	`render()` Render the context's underlying SQL statement.
`String`	`render(QueryPart part)` Render a query part in a new context derived from this one.
`C`	`sql(char sql)` Append some SQL to the context's contained `StringBuilder`.
`C`	`sql(int sql)` Append some SQL to the context's contained `StringBuilder`.
`C`	`sql(String sql)` Append some SQL to the context's contained `StringBuilder`.
`C`	`sql(String sql, boolean literal)` Append some SQL to the context's contained `StringBuilder`.
`C`	`start(Clause clause)` TODO [#2667] Properties of these methods: - A clause is always started / ended, even if it isn't rendered or if it's empty!
`PreparedStatement`	`statement()` Retrieve the context's underlying `PreparedStatement` if available, or `null` if this traversal does not operate on a `PreparedStatement`.
`boolean`	`subquery()` Whether the current context is rendering a sub-query (nested query)
`C`	`subquery(boolean subquery)` Set the new context value for `subquery()`
`C`	`visit(QueryPart part)` Visit a `QueryPart` in the current `Context`.

- Method Detail
  - configuration
```
Configuration configuration()
```
    The configuration wrapped by this context.
  - data
```
Map<Object,Object> data()
```
    Get all custom data from this Context.
    This is custom data that was previously set to the context using data(Object, Object). Use custom data if you want to pass data to QueryPart objects for a given RenderContext or BindContext.
    Unlike Configuration.data(), these data's lifecycle only matches that of a render or bind context.
    
    Returns:
    
    The custom data. This is never null
  - data
```
Object data(Object key)
```
    Get some custom data from this Context.
    This is custom data that was previously set to the context using data(Object, Object). Use custom data if you want to pass data to QueryPart objects for a given RenderContext or BindContext.
    Unlike Configuration.data(), these data's lifecycle only matches that of a render or bind context.
    
    Parameters:
    
    key - A key to identify the custom data
    
    Returns:
    
    The custom data or null if no such data is contained in this ExecuteContext
    
    See Also:
    
    ExecuteListener
  - data
```
Object data(Object key,
            Object value)
```
    Set some custom data to this Context.
    This is custom data that was previously set to the context using data(Object, Object). Use custom data if you want to pass data to QueryPart objects for a given RenderContext or BindContext.
    Unlike Configuration.data(), these data's lifecycle only matches that of a render or bind context.
    
    Parameters:
    
    key - A key to identify the custom data
    
    value - The custom data
    
    Returns:
    
    The previously set custom data or null if no data was previously set for the given key
    
    See Also:
    
    ExecuteListener
  - visit
```
C visit(QueryPart part)
 throws DataAccessException
```
    Visit a QueryPart in the current Context.
    This method is called by certain QueryPart implementations to recursively visit component QueryParts.
    
    Parameters:
    
    part - The component QueryPart
    
    Throws:
    
    DataAccessException - If something went wrong while visiting the component QueryPart, e.g. when binding a variable
  - start
```
C start(Clause clause)
```
    TODO [#2667] Properties of these methods: - A clause is always started / ended, even if it isn't rendered or if it's empty!
  - end
```
C end(Clause clause)
```
  - declareFields
```
boolean declareFields()
```
    Whether the current context is rendering a SQL field declaration (e.g. a Field in the SELECT clause of the query).
  - declareFields
```
C declareFields(boolean declareFields)
```
    Set the new context value for declareFields()
  - declareTables
```
boolean declareTables()
```
    Whether the current context is rendering a SQL table declaration (e.g. a Table in the FROM or JOIN clause of the query).
  - declareTables
```
C declareTables(boolean declareTables)
```
    Set the new context value for declareTables()
  - declareWindows
```
boolean declareWindows()
```
    Whether the current context is rendering a SQL window declaration (e.g. a WindowDefinition in the WINDOW clause of the query).
  - declareWindows
```
C declareWindows(boolean declareWindows)
```
    Set the new context value for declareWindows()
  - declareCTE
```
boolean declareCTE()
```
    Whether the current context is rendering a common table expression (e.g. a CommonTableExpression in the WITH clause of the query).
  - declareCTE
```
C declareCTE(boolean declareCTE)
```
    Set the new context value for declareCTE()
  - subquery
```
boolean subquery()
```
    Whether the current context is rendering a sub-query (nested query)
  - subquery
```
C subquery(boolean subquery)
```
    Set the new context value for subquery()
  - nextIndex
```
int nextIndex()
```
    Get the next bind index. This increments an internal counter. This is relevant for two use-cases:
    - When binding variables to a PreparedStatement. Client code must assure that calling nextIndex() is followed by setting a bind value to BindContext.statement()
    - When rendering unnamed bind variables with RenderContext.paramType() being to NAMED
  - peekIndex
```
int peekIndex()
```
    Peek the next bind index. This won't increment the internal counter, unlike nextIndex()
  - statement
```
PreparedStatement statement()
```
    Retrieve the context's underlying PreparedStatement if available, or null if this traversal does not operate on a PreparedStatement.
  - bindValue
```
BindContext bindValue(Object value,
                      Field<?> field)
               throws DataAccessException
```
    Bind a value using a specific type. This will also increment the internal counter.
    
    Throws:
    
    DataAccessException - If something went wrong while binding a variable
  - peekAlias
```
String peekAlias()
```
    Peek the next alias that will be generated by nextAlias().
  - nextAlias
```
String nextAlias()
```
    Return a new alias that is unique for the scope of one query. These aliases are sometimes needed when unaliased projections are defined in subqueries, which can lead to syntax errors.
  - render
```
String render()
```
    Render the context's underlying SQL statement.
  - render
```
String render(QueryPart part)
```
    Render a query part in a new context derived from this one. The rendered SQL will not be appended to this context.
  - keyword
```
C keyword(String keyword)
```
    Append a SQL keyword to the context's contained StringBuilder.
    Use this to have your SQL keyword rendered in RenderKeywordStyle (upper or lower case)
  - sql
```
C sql(String sql)
```
    Append some SQL to the context's contained StringBuilder.
  - sql
```
C sql(String sql,
      boolean literal)
```
    Append some SQL to the context's contained StringBuilder.
    Set literal = true to indicate that the RenderContext shall not format the argument SQL.
  - sql
```
C sql(char sql)
```
    Append some SQL to the context's contained StringBuilder.
  - sql
```
C sql(int sql)
```
    Append some SQL to the context's contained StringBuilder.
  - format
```
C format(boolean format)
```
    Override the value of Settings.isRenderFormatted().
  - format
```
boolean format()
```
    The value of Settings.isRenderFormatted().
  - formatNewLine
```
C formatNewLine()
```
    Render a new line character (only if Settings.isRenderFormatted() is set to true).
  - formatNewLineAfterPrintMargin
```
C formatNewLineAfterPrintMargin()
```
    Render a new line character (only if Settings.isRenderFormatted() is set to true, and the formatPrintMargin(int) has been exceeded).
  - formatSeparator
```
C formatSeparator()
```
    Render a new line character (only if Settings.isRenderFormatted() is set to true), or a whitespace separator character otherwise.
  - formatIndentStart
```
C formatIndentStart()
```
    Start indenting subsequent SQL by one level (two characters), if Settings.isRenderFormatted() is set to true.
    This is the same as calling formatIndentStart(int) with a parameter of 2
  - formatIndentStart
```
C formatIndentStart(int indent)
```
    Start indenting subsequent SQL by a number of characters, if Settings.isRenderFormatted() is set to true.
  - formatIndentLockStart
```
C formatIndentLockStart()
```
    Start indenting subsequent SQL at the same level as the current line, if Settings.isRenderFormatted() is set to true.
  - formatIndentEnd
```
C formatIndentEnd()
```
    Stop indenting subsequent SQL by one level (two characters), if Settings.isRenderFormatted() is set to true.
    This is the same as calling formatIndentEnd(int) with a parameter of 2
  - formatIndentEnd
```
C formatIndentEnd(int indent)
```
    Stop indenting subsequent SQL by a number of characters, if Settings.isRenderFormatted() is set to true.
  - formatIndentLockEnd
```
C formatIndentLockEnd()
```
    Stop indenting subsequent SQL at the same level as the current line, if Settings.isRenderFormatted() is set to true.
  - formatPrintMargin
```
C formatPrintMargin(int margin)
```
    Set a print margin that will be applied to formatted SQL, if Settings.isRenderFormatted() is set to true.
    The default print margin is 80. Setting this to zero or a negative value means that no print margin will be applied.
    The print margin is applied to any of these QueryParts:
    - Field.in(Field...) and related expressions
  - literal
```
C literal(String literal)
```
    Append some (quoted) literal to the context's contained StringBuilder.
  - qualify
```
boolean qualify()
```
    Whether query parts should render qualified names or not.
  - qualify
```
C qualify(boolean qualify)
```
    Sett the new context value for qualify().
  - paramType
```
ParamType paramType()
```
    Specify, how bind values should be rendered.
    - As ParamType.INDEXED parameters:
      ?, ?, ?
    - As ParamType.NAMED parameters:
      :1, :2, :custom_name
    - As ParamType.INLINED parameters:
      1, 'A', null
  - paramType
```
C paramType(ParamType paramType)
```
    Set the new context value for paramType().
  - castMode
```
RenderContext.CastMode castMode()
```
    The currently applied cast mode for bind values.
  - castMode
```
C castMode(RenderContext.CastMode mode)
```
    Set the new cast mode for castMode().
  - cast
```
Boolean cast()
```
    Whether casting must be applied. The result follows this logic:
    
    CastMode result
    
    ALWAYS true
    
    NEVER false
    
    SOME true or false depending on the dialect
    
    DEFAULT null
  - castModeSome
```
C castModeSome(SQLDialect... dialects)
```
    Set the new cast mode to RenderContext.CastMode.SOME for a list of dialects.

CastMode	result
`ALWAYS`	`true`
`NEVER`	`false`
`SOME`	`true` or `false` depending on the dialect
`DEFAULT`	`null`

Interface Context<C extends Context<C>>

Method Summary

Method Detail

configuration

data

data

data

visit

start

end

declareFields

declareFields

declareTables

declareTables

declareWindows

declareWindows

declareCTE

declareCTE

subquery

subquery

nextIndex

peekIndex

statement

bindValue

peekAlias

nextAlias

render

render

keyword

sql

sql

sql

sql

format

format

formatNewLine

formatNewLineAfterPrintMargin

formatSeparator

formatIndentStart

formatIndentStart

formatIndentLockStart

formatIndentEnd

formatIndentEnd

formatIndentLockEnd

formatPrintMargin

literal

qualify

qualify

paramType

paramType

castMode

castMode

cast

castModeSome