Available in versions: Dev (3.20) | Latest (3.19) | 3.18 | 3.17 | 3.16 | 3.15 | 3.14 | 3.13 | 3.12 | 3.11 | 3.10

SQL building

Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition

SQL is a declarative language that is hard to integrate into procedural, object-oriented, functional or any other type of programming languages. jOOQ's philosophy is to give SQL the credit it deserves and integrate SQL itself as an "internal domain specific language" directly into Java.

With this philosophy in mind, SQL building is the main feature of jOOQ. All other features (such as SQL execution and code generation) are mere convenience built on top of jOOQ's SQL building capabilities.

This section explains all about the various syntax elements involved with jOOQ's SQL building capabilities. For a complete overview of all syntax elements, please refer to the manual's sections about SQL to DSL mapping rules.

3.1.: The query DSL type
3.1.1.: DSL subclasses
3.2.: The DSLContext API
3.2.1.: SQL Dialect
3.2.2.: SQL Dialect Family
3.2.3.: Connection vs. DataSource
3.2.4.: Custom data
3.2.5.: Custom ExecuteListeners
3.2.6.: Custom Unwrappers (new)
3.2.7.: Custom Settings
3.2.7.1.: Auto-attach Records
3.2.7.2.: Backslash Escaping
3.2.7.3.: Execute Logging
3.2.7.4.: Fetch Warnings
3.2.7.5.: Identifier style
3.2.7.6.: Inline Threshold (new)
3.2.7.7.: IN-list Padding
3.2.7.8.: JDBC Flags
3.2.7.9.: Keyword style
3.2.7.10.: Listener Invocation Order (new)
3.2.7.11.: Locales (new)
3.2.7.12.: Map JPA Annotations
3.2.7.13.: Object qualification
3.2.7.14.: Optimistic Locking
3.2.7.15.: Parameter name prefix (new)
3.2.7.16.: Parameter types
3.2.7.17.: Parser Configuration (new)
3.2.7.18.: Reflection caching
3.2.7.19.: Return all columns on store
3.2.7.20.: Return Identity Value On Store (new)
3.2.7.21.: Runtime schema and table mapping
3.2.7.22.: Scalar subqueries for stored functions
3.2.7.23.: Statement Type
3.2.7.24.: Updatable Primary Keys
3.2.8.: Thread safety
3.3.: SQL Statements (DML)
3.3.1.: jOOQ's DSL and model API
3.3.2.: The WITH clause
3.3.3.: The WITH RECURSIVE clause
3.3.4.: The SELECT statement
3.3.4.1.: SELECT clause
3.3.4.1.1.: Projection type safety
3.3.4.1.2.: SelectField
3.3.4.1.3.: SELECT *
3.3.4.1.4.: SELECT * EXCEPT (...) (new)
3.3.4.1.5.: SELECT DISTINCT
3.3.4.1.6.: SELECT DISTINCT ON
3.3.4.1.7.: Convenience methods
3.3.4.2.: FROM clause
3.3.4.3.: JOIN operator
3.3.4.4.: Implicit path JOIN
3.3.4.5.: WHERE clause
3.3.4.6.: CONNECT BY clause
3.3.4.7.: GROUP BY clause
3.3.4.7.1.: GROUP BY columns
3.3.4.7.2.: GROUP BY ROLLUP
3.3.4.7.3.: GROUP BY CUBE
3.3.4.7.4.: GROUP BY GROUPING SETS
3.3.4.7.5.: GROUP BY empty grouping set
3.3.4.8.: HAVING clause
3.3.4.9.: WINDOW clauseWINDOW clause
3.3.4.10.: QUALIFY clause (new)
3.3.4.11.: ORDER BY clause
3.3.4.11.1.: Ordering by field index
3.3.4.11.2.: Ordering and NULLS
3.3.4.11.3.: Ordering using CASE expressions
3.3.4.11.4.: Oracle's ORDER SIBLINGS BY clause
3.3.4.12.: LIMIT .. OFFSET clause
3.3.4.13.: WITH TIES clause
3.3.4.14.: SEEK clause
3.3.4.15.: FOR UPDATE clause
3.3.4.16.: Set operations
3.3.4.16.1.: Type safety
3.3.4.16.2.: Projection rowtype
3.3.4.16.3.: Differences to standard SQL
3.3.4.16.4.: UNION
3.3.4.16.5.: INTERSECT
3.3.4.16.6.: EXCEPT
3.3.4.17.: Lexical and logical SELECT clause order
3.3.5.: The INSERT statement
3.3.5.1.: INSERT .. VALUES
3.3.5.2.: INSERT .. DEFAULT VALUES
3.3.5.3.: INSERT .. SET
3.3.5.4.: INSERT .. SELECT
3.3.5.5.: INSERT .. ON DUPLICATE KEY UPDATE
3.3.5.6.: INSERT .. ON DUPLICATE KEY IGNORE
3.3.5.7.: INSERT .. ON CONFLICT
3.3.5.8.: INSERT .. RETURNING
3.3.6.: The UPDATE statement
3.3.6.1.: UPDATE .. SET
3.3.6.2.: UPDATE .. SET ROW
3.3.6.3.: UPDATE .. FROM
3.3.6.4.: UPDATE .. WHERE
3.3.6.5.: UPDATE .. ORDER BY .. LIMIT (new)
3.3.6.6.: UPDATE .. RETURNING
3.3.7.: The DELETE statement
3.3.7.1.: DELETE .. WHERE
3.3.7.2.: DELETE .. ORDER BY .. LIMIT (new)
3.3.7.3.: UPDATE .. RETURNING
3.3.8.: The MERGE statement
3.4.: SQL Statements (DDL)
3.4.1.: The ALTER statement
3.4.1.1.: ALTER INDEX
3.4.1.1.1.: ALTER INDEX .. RENAME
3.4.1.1.2.: ALTER INDEX IF EXISTS
3.4.1.2.: ALTER SCHEMA
3.4.1.2.1.: ALTER SCHEMA .. RENAME
3.4.1.2.2.: ALTER SCHEMA IF EXISTS
3.4.1.3.: ALTER SEQUENCE
3.4.1.3.1.: ALTER SEQUENCE .. RENAME
3.4.1.3.2.: ALTER SEQUENCE .. RESTART
3.4.1.3.3.: ALTER SEQUENCE IF EXISTS
3.4.1.4.: ALTER TABLE
3.4.1.4.1.: ALTER TABLE .. ADD COLUMN
3.4.1.4.2.: ALTER TABLE .. ADD COLUMNS
3.4.1.4.3.: ALTER TABLE .. ADD COLUMN IF NOT EXISTS
3.4.1.4.4.: ALTER TABLE .. ADD PRIMARY KEY
3.4.1.4.5.: ALTER TABLE .. ADD UNIQUE
3.4.1.4.6.: ALTER TABLE .. ADD FOREIGN KEY
3.4.1.4.7.: ALTER TABLE .. ADD CHECK
3.4.1.4.8.: ALTER TABLE .. RENAME
3.4.1.4.9.: ALTER TABLE .. COMMENT
3.4.1.4.10.: ALTER TABLE .. ALTER COLUMN .. SET DEFAULT
3.4.1.4.11.: ALTER TABLE .. ALTER COLUMN .. SET NOT NULL
3.4.1.4.12.: ALTER TABLE .. ALTER COLUMN .. DROP NOT NULL
3.4.1.4.13.: ALTER TABLE .. ALTER COLUMN .. SET TYPE
3.4.1.4.14.: ALTER TABLE .. RENAME COLUMN
3.4.1.4.15.: ALTER TABLE .. RENAME CONSTRAINT
3.4.1.4.16.: ALTER TABLE .. RENAME INDEX
3.4.1.4.17.: ALTER TABLE .. DROP COLUMN
3.4.1.4.18.: ALTER TABLE .. DROP COLUMN RESTRICT
3.4.1.4.19.: ALTER TABLE .. DROP COLUMN CASCADE
3.4.1.4.20.: ALTER TABLE .. DROP COLUMNS
3.4.1.4.21.: ALTER TABLE .. ADD COLUMN IF NOT EXISTS
3.4.1.4.22.: ALTER TABLE .. DROP CONSTRAINT
3.4.1.4.23.: ALTER TABLE .. DROP PRIMARY KEY (new)
3.4.1.4.24.: ALTER TABLE .. DROP FOREIGN KEY (new)
3.4.1.4.25.: ALTER TABLE IF EXISTS
3.4.1.5.: ALTER VIEW
3.4.1.5.1.: ALTER VIEW .. COMMENT
3.4.1.5.2.: ALTER VIEW .. RENAME
3.4.1.5.3.: ALTER VIEW IF EXISTS
3.4.2.: The COMMENT statement
3.4.2.1.: COMMENT ON TABLE
3.4.2.2.: COMMENT ON VIEW
3.4.2.3.: COMMENT ON COLUMN
3.4.3.: The CREATE statement
3.4.3.1.: CREATE INDEX
3.4.3.2.: CREATE SCHEMA
3.4.3.3.: CREATE SEQUENCE
3.4.3.3.1.: CREATE SEQUENCE IF NOT EXISTS
3.4.3.4.: CREATE TABLE
3.4.3.4.1.: Columns
3.4.3.4.2.: Nullability
3.4.3.4.3.: Defaults
3.4.3.4.4.: Identities
3.4.3.4.5.: Primary key
3.4.3.4.6.: Unique constraints
3.4.3.4.7.: Foreign keys
3.4.3.4.8.: Check constraints
3.4.3.4.9.: From a SELECT
3.4.3.4.10.: Temporary tables
3.4.3.5.: CREATE TYPE (new)
3.4.3.6.: CREATE VIEW
3.4.3.6.1.: CREATE OR REPLACE VIEW
3.4.3.6.2.: WITH CHECK OPTION
3.4.3.6.3.: WITH READ ONLY
3.4.4.: The DROP statement
3.4.4.1.: DROP INDEX
3.4.4.1.1.: DROP INDEX IF EXISTS
3.4.4.2.: DROP SCHEMA
3.4.4.2.1.: DROP SCHEMA IF EXISTS
3.4.4.3.: DROP SEQUENCE
3.4.4.3.1.: DROP SEQUENCE IF EXISTS
3.4.4.4.: DROP TABLE
3.4.4.4.1.: DROP TABLE IF EXISTS
3.4.4.5.: DROP TYPE (new)
3.4.4.5.1.: DROP TYPE IF EXISTS (new)
3.4.4.6.: DROP VIEW
3.4.4.6.1.: DROP VIEW IF EXISTS
3.4.5.: The GRANT statement
3.4.6.: The REVOKE statement
3.4.7.: The SET statement
3.4.7.1.: SET CATALOG
3.4.7.2.: SET SCHEMA
3.4.8.: The TRUNCATE statement
3.4.9.: Generating DDL from objects
3.5.: Procedural statements (new)
3.5.1.: Block statement (new)
3.5.2.: CONTINUE statement (new)
3.5.3.: EXECUTE statement (new)
3.5.4.: EXIT statement (new)
3.5.5.: FOR statement (new)
3.5.6.: GOTO statement (new)
3.5.7.: IF statement (new)
3.5.8.: Labels (new)
3.5.9.: LOOP statement (new)
3.5.10.: REPEAT statement (new)
3.5.11.: Variables (new)
3.5.12.: WHILE statement (new)
3.6.: Catalog and schema expressions
3.7.: Table expressions
3.7.1.: Generated Tables
3.7.2.: Aliased Tables
3.7.2.1.: Aliased generated tables
3.7.2.2.: Aliased table expressions
3.7.2.3.: Derived column lists
3.7.2.4.: Unnamed derived tables
3.7.3.: Joined tables
3.7.3.1.: CROSS JOIN
3.7.3.2.: INNER JOIN
3.7.3.3.: OUTER JOIN
3.7.3.4.: SEMI JOIN
3.7.3.5.: ANTI JOIN
3.7.3.6.: ON clause
3.7.3.7.: ON KEY clause
3.7.3.8.: USING clause
3.7.3.9.: NATURAL clause
3.7.3.10.: LATERAL
3.7.3.11.: APPLY
3.7.3.12.: PARTITION BY
3.7.4.: The VALUES() table constructor
3.7.5.: Derived tables
3.7.6.: Inline derived tables (new)
3.7.7.: The Oracle PIVOT clause
3.7.8.: Relational division
3.7.9.: Array and cursor unnesting
3.7.10.: Table-valued functions
3.7.11.: GENERATE_SERIES
3.7.12.: The DUAL table
3.8.: Column expressions
3.8.1.: Table columns
3.8.1.1.: Generated table columns
3.8.1.2.: Dereferenced table columns
3.8.1.3.: Named table columns
3.8.2.: Aliased columns
3.8.3.: Cast expressions
3.8.4.: Datatype coercions
3.8.5.: Collations
3.8.6.: Arithmetic expressions
3.8.7.: String concatenation
3.8.8.: Case sensitivity with strings
3.8.9.: General functions
3.8.9.1.: CHOOSE
3.8.9.2.: COALESCE
3.8.9.3.: DECODE
3.8.9.4.: IIF
3.8.9.5.: NULLIF
3.8.9.6.: NVL
3.8.9.7.: NVL2
3.8.10.: Numeric functions
3.8.10.1.: ABS
3.8.10.2.: ACOS
3.8.10.3.: ASIN
3.8.10.4.: ATAN
3.8.10.5.: ATAN2
3.8.10.6.: CEIL
3.8.10.7.: COS
3.8.10.8.: COSH
3.8.10.9.: COT
3.8.10.10.: COTH
3.8.10.11.: DEG
3.8.10.12.: E
3.8.10.13.: EXP
3.8.10.14.: FLOOR
3.8.10.15.: GREATEST
3.8.10.16.: LEAST
3.8.10.17.: LN
3.8.10.18.: LOG
3.8.10.19.: NEG
3.8.10.20.: PI
3.8.10.21.: POWER
3.8.10.22.: RAD
3.8.10.23.: RAND
3.8.10.24.: ROUND
3.8.10.25.: SIGN
3.8.10.26.: SIN
3.8.10.27.: SINH
3.8.10.28.: SQRT
3.8.10.29.: TAN
3.8.10.30.: TANH
3.8.10.31.: TRUNC
3.8.10.32.: WIDTH_BUCKET
3.8.11.: Bitwise functions
3.8.11.1.: BIT_AND
3.8.11.2.: BIT_COUNT
3.8.11.3.: BIT_NAND
3.8.11.4.: BIT_NOR
3.8.11.5.: BIT_NOT
3.8.11.6.: BIT_OR
3.8.11.7.: BIT_XNOR
3.8.11.8.: BIT_XOR
3.8.11.9.: SHL
3.8.11.10.: SHR
3.8.12.: String functions
3.8.12.1.: ASCII
3.8.12.2.: BIT_LENGTH
3.8.12.3.: CONCAT (|| operator)
3.8.12.4.: LEFT
3.8.12.5.: LENGTH
3.8.12.6.: LOWER
3.8.12.7.: LPAD
3.8.12.8.: LTRIM
3.8.12.9.: MD5
3.8.12.10.: MID
3.8.12.11.: OCTET_LENGTH
3.8.12.12.: POSITION
3.8.12.13.: REPEAT
3.8.12.14.: REPLACE
3.8.12.15.: REVERSE
3.8.12.16.: RIGHT
3.8.12.17.: RPAD
3.8.12.18.: RTRIM
3.8.12.19.: SPACE
3.8.12.20.: SUBSTRING
3.8.12.21.: TRANSLATE
3.8.12.22.: TRIM
3.8.12.23.: UPPER
3.8.13.: Datetime functions
3.8.13.1.: CENTURY (new)
3.8.13.2.: CURRENT_DATE
3.8.13.3.: CURRENT_LOCALDATE
3.8.13.4.: CURRENT_LOCALDATETIME
3.8.13.5.: CURRENT_LOCALTIME
3.8.13.6.: CURRENT_OFFSETDATETIME
3.8.13.7.: CURRENT_OFFSETTIME
3.8.13.8.: CURRENT_TIME
3.8.13.9.: CURRENT_TIMESTAMP
3.8.13.10.: DATE
3.8.13.11.: DATEADD
3.8.13.12.: DATEDIFF
3.8.13.13.: DATESUB
3.8.13.14.: DAY
3.8.13.15.: DAY_OF_YEAR (new)
3.8.13.16.: DECADE (new)
3.8.13.17.: EPOCH (new)
3.8.13.18.: EXTRACT
3.8.13.19.: HOUR
3.8.13.20.: ISO_DAY_OF_WEEK (new)
3.8.13.21.: LOCALDATE
3.8.13.22.: LOCALDATEADD
3.8.13.23.: LOCALDATESUB
3.8.13.24.: LOCALDATETIME
3.8.13.25.: LOCALDATETIMEADD
3.8.13.26.: LOCALDATETIMESUB
3.8.13.27.: LOCALTIME
3.8.13.28.: MILLENNIUM (new)
3.8.13.29.: MINUTE
3.8.13.30.: MONTH
3.8.13.31.: QUARTER (new)
3.8.13.32.: SECOND
3.8.13.33.: TIME
3.8.13.34.: TIMESTAMP
3.8.13.35.: TIMESTAMPADD
3.8.13.36.: TIMESTAMPSUB
3.8.13.37.: TO_DATE
3.8.13.38.: TO_LOCALDATE
3.8.13.39.: TO_LOCALDATETIME
3.8.13.40.: TO_TIMESTAMP
3.8.13.41.: TRUNC
3.8.13.42.: YEAR
3.8.14.: ARRAY functions
3.8.14.1.: ARRAY constructor
3.8.15.: JSON functions (new)
3.8.15.1.: JSON_ARRAY (new)
3.8.15.2.: JSON_OBJECT (new)
3.8.16.: System functions
3.8.16.1.: CURRENT_SCHEMA
3.8.16.2.: CURRENT_USER
3.8.17.: Aggregate functions
3.8.17.1.: Grouping
3.8.17.2.: Distinctness
3.8.17.3.: Filtering
3.8.17.4.: Ordering
3.8.17.5.: Ordering WITHIN GROUP
3.8.17.6.: Keeping
3.8.17.7.: ARRAY_AGG
3.8.17.8.: AVG
3.8.17.9.: BOOL_AND
3.8.17.10.: BOOL_OR
3.8.17.11.: COLLECT
3.8.17.12.: COUNT
3.8.17.13.: CUME_DIST
3.8.17.14.: DENSE_RANK
3.8.17.15.: EVERY
3.8.17.16.: GROUP_CONCAT
3.8.17.17.: LISTAGG
3.8.17.18.: MAX
3.8.17.19.: MEDIAN
3.8.17.20.: MIN
3.8.17.21.: MODE
3.8.17.22.: PERCENT_RANK
3.8.17.23.: PERCENTILE_CONT
3.8.17.24.: PERCENTILE_DISC
3.8.17.25.: PRODUCT
3.8.17.26.: RANK
3.8.17.27.: SUM
3.8.18.: Window functions
3.8.18.1.: PARTITION BY
3.8.18.2.: ORDER BY
3.8.18.3.: ROWS, RANGE, GROUPS (frame clause)
3.8.18.4.: EXCLUDE
3.8.18.5.: NULL treatment
3.8.18.6.: FROM FIRST, FROM LAST
3.8.18.7.: Nested aggregate functions
3.8.18.8.: Window aggregation
3.8.18.9.: Window ordered aggregate
3.8.18.10.: ROW_NUMBER
3.8.18.11.: RANK
3.8.18.12.: DENSE_RANK
3.8.18.13.: PERCENT_RANK
3.8.18.14.: CUME_DIST
3.8.18.15.: NTILE
3.8.18.16.: LEAD
3.8.18.17.: LAG
3.8.18.18.: FIRST_VALUE
3.8.18.19.: LAST_VALUE
3.8.18.20.: NTH_VALUE
3.8.19.: User-defined functions
3.8.20.: User-defined aggregate functions
3.8.21.: The CASE expression
3.8.22.: Sequences and serials
3.8.23.: Scalar subqueries
3.8.24.: Tuples or row value expressions
3.9.: Conditional expressions
3.9.1.: Condition building
3.9.2.: TRUE and FALSE condition
3.9.3.: BOOLEAN columns
3.9.4.: AND, OR, NOT boolean operators
3.9.5.: Boolean operator precedence
3.9.6.: Comparison predicate
3.9.7.: Comparison predicate (degree > 1)
3.9.8.: Quantified comparison predicate
3.9.9.: BETWEEN predicate
3.9.10.: BETWEEN predicate (degree > 1)
3.9.11.: DISTINCT predicate
3.9.12.: DISTINCT predicate (degree > 1)
3.9.13.: EXISTS predicate
3.9.14.: IN predicate
3.9.15.: IN predicate (degree > 1)
3.9.16.: JSON predicate (new)
3.9.17.: LIKE predicate
3.9.18.: Quantified LIKE predicate (new)
3.9.19.: NULL predicate
3.9.20.: NULL predicate (degree > 1)
3.9.21.: OVERLAPS predicate
3.9.22.: SIMILAR TO predicate (new)
3.9.23.: UNIQUE predicate (new)
3.9.24.: Query By Example (QBE)
3.10.: Operator precedence
3.11.: Synthetic SQL clauses
3.12.: Dynamic SQL
3.12.1.: Optional conditional expressions
3.13.: Plain SQL
3.14.: Plain SQL Templating Language
3.15.: Hints
3.15.1.: MySQL hints
3.15.1.1.: Index hints
3.15.1.2.: STRAIGHT_JOIN
3.15.1.3.: Oracle style hints in MySQL
3.15.2.: Oracle hints
3.15.3.: SQL Server hints
3.15.3.1.: WITH
3.15.3.2.: OPTION
3.16.: SQL Parser
3.16.1.: SQL Parser API
3.16.2.: SQL Parser CLI
3.16.3.: SQL translator
3.16.4.: SQL Parser Grammar
3.17.: Names and identifiers
3.18.: Bind values and parameters
3.18.1.: Indexed parameters
3.18.2.: Named parameters
3.18.3.: Inlined parameters
3.18.4.: SQL injection
3.19.: QueryParts
3.19.1.: SQL rendering
3.19.2.: Declaration vs reference
3.19.3.: Pretty printing SQL
3.19.4.: Variable binding
3.19.5.: Custom data type bindings
3.19.6.: Custom syntax elements
3.19.7.: Plain SQL QueryParts
3.19.8.: Serializability
3.19.9.: Custom SQL transformation with VisitListener
3.19.9.1.: Example: Logging abbreviated bind values
3.20.: Zero-based vs one-based APIs
3.21.: SQL building in Scala

previous : next

References to this page

Feedback

Do you have any feedback about this page? We'd love to hear it!

Tell us a little bit about yourself and join our newsletter (examples)

SQL building

Table of contents

References to this page

Feedback

Community

Support

Legal

Documentation