Top Description Inners Methods
org.jooq

public Interface Name

extends QueryPart, Comparable<Name>
Known Direct Implementers
org.jooq.impl.AbstractName
Static Imports
org.jooq.SQLDialect.CUBRID, .SQLDialect.FIREBIRD, .SQLDialect.H2, .SQLDialect.HSQLDB, .SQLDialect.IGNITE, .SQLDialect.MARIADB, .SQLDialect.MYSQL, .SQLDialect.POSTGRES, .SQLDialect.SQLITE, .SQLDialect.YUGABYTEDB

An identifier.

A Name or identifier is a QueryPart that renders a SQL identifier according to the settings specified in Settings#getRenderQuotedNames() and Settings#getRenderNameCase().

Example:


// Assuming import static org.jooq.impl.DSL.*;

using(configuration)
   .select(
        field(name("FIRST_NAME"), SQLDataType.VARCHAR),
        field(name("LAST_NAME"), SQLDataType.VARCHAR))
   .from(table(name("ACTOR")))
   .fetch();

Instances can be created using DSL#name(String) and overloads.

Author
Lukas Eder

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
Name.Quoted

A flag indicating whether the name is quoted or not.

Method Summary

Modifier and TypeMethod and Description
public @NotNull Name
append(String name)

Appends name to this name.

public @NotNull Name
append(Name name)

Appends name (all of its parts()) to this name.

public @NotNull WindowDefinition
as()

Deprecated as a consequence of WindowDefinition being deprecated.
Create an empty WindowDefinition from this name.
public @NotNull WindowDefinition
as(WindowSpecification window)

Deprecated as a consequence of WindowDefinition being deprecated.
Create a WindowDefinition from this name.
public <R extends Record> @NotNull CommonTableExpression<R>
as(ResultQuery<R> query)

Specify a subselect to refer to by the Name to form a common table expression.

public <R extends Record> @NotNull CommonTableExpression<R>
asMaterialized(ResultQuery<R> query)

Specify a materialized subselect to refer to by the Name to form a common table expression.

public <R extends Record> @NotNull CommonTableExpression<R>
asNotMaterialized(ResultQuery<R> query)

Specify a non-materialized subselect to refer to by the Name to form a common table expression.

public int
compareTo(Name
the object to be compared.
o
)

Redeclares java.lang.Comparable.compareTo.

Compare two unquotedName() by their qualified string versions.
public boolean
empty()

Whether this is the empty name.

public boolean
equals(Object
The other QueryPart
other
)

Redeclares org.jooq.QueryPart.equals.

Check whether this QueryPart can be considered equal to another QueryPart.
public boolean
equalsIgnoreCase(Name other)

Compare this name with another one ignoring case.

public @NotNull DerivedColumnList
fields(String... fieldNames)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList
fields(Name... fieldNames)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList
fields(Function<? super Field<?>, ? extends String> fieldNameFunction)

Deprecated for removal since 3.14. - 3.14.0 - [#10156] - These methods will be removed without replacement from a future jOOQ.
Add a list of fields to this name to make this name a DerivedColumnList.
public @NotNull DerivedColumnList
fields(BiFunction<? super Field<?>, ? super Integer, ? extends String> fieldNameFunction)

Deprecated for removal since 3.14. - 3.14.0 - [#10156] - These methods will be removed without replacement from a future jOOQ.
Add a list of fields to this name to make this name a DerivedColumnList.
public @NotNull DerivedColumnList1
fields(String fieldName1)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList2
fields(String fieldName1, String fieldName2)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList3
fields(String fieldName1, String fieldName2, String fieldName3)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList4
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList5
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList6
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList7
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList8
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList9
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList10
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9, String fieldName10)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList11
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9, String fieldName10, String fieldName11)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList12
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9, String fieldName10, String fieldName11, String fieldName12)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList13
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9, String fieldName10, String fieldName11, String fieldName12, String fieldName13)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList14
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9, String fieldName10, String fieldName11, String fieldName12, String fieldName13, String fieldName14)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList15
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9, String fieldName10, String fieldName11, String fieldName12, String fieldName13, String fieldName14, String fieldName15)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList16
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9, String fieldName10, String fieldName11, String fieldName12, String fieldName13, String fieldName14, String fieldName15, String fieldName16)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList17
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9, String fieldName10, String fieldName11, String fieldName12, String fieldName13, String fieldName14, String fieldName15, String fieldName16, String fieldName17)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList18
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9, String fieldName10, String fieldName11, String fieldName12, String fieldName13, String fieldName14, String fieldName15, String fieldName16, String fieldName17, String fieldName18)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList19
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9, String fieldName10, String fieldName11, String fieldName12, String fieldName13, String fieldName14, String fieldName15, String fieldName16, String fieldName17, String fieldName18, String fieldName19)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList20
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9, String fieldName10, String fieldName11, String fieldName12, String fieldName13, String fieldName14, String fieldName15, String fieldName16, String fieldName17, String fieldName18, String fieldName19, String fieldName20)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList21
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9, String fieldName10, String fieldName11, String fieldName12, String fieldName13, String fieldName14, String fieldName15, String fieldName16, String fieldName17, String fieldName18, String fieldName19, String fieldName20, String fieldName21)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList22
fields(String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9, String fieldName10, String fieldName11, String fieldName12, String fieldName13, String fieldName14, String fieldName15, String fieldName16, String fieldName17, String fieldName18, String fieldName19, String fieldName20, String fieldName21, String fieldName22)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList1
fields(Name fieldName1)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList2
fields(Name fieldName1, Name fieldName2)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList3
fields(Name fieldName1, Name fieldName2, Name fieldName3)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList4
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList5
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList6
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList7
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList8
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList9
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList10
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9, Name fieldName10)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList11
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9, Name fieldName10, Name fieldName11)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList12
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9, Name fieldName10, Name fieldName11, Name fieldName12)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList13
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9, Name fieldName10, Name fieldName11, Name fieldName12, Name fieldName13)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList14
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9, Name fieldName10, Name fieldName11, Name fieldName12, Name fieldName13, Name fieldName14)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList15
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9, Name fieldName10, Name fieldName11, Name fieldName12, Name fieldName13, Name fieldName14, Name fieldName15)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList16
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9, Name fieldName10, Name fieldName11, Name fieldName12, Name fieldName13, Name fieldName14, Name fieldName15, Name fieldName16)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList17
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9, Name fieldName10, Name fieldName11, Name fieldName12, Name fieldName13, Name fieldName14, Name fieldName15, Name fieldName16, Name fieldName17)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList18
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9, Name fieldName10, Name fieldName11, Name fieldName12, Name fieldName13, Name fieldName14, Name fieldName15, Name fieldName16, Name fieldName17, Name fieldName18)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList19
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9, Name fieldName10, Name fieldName11, Name fieldName12, Name fieldName13, Name fieldName14, Name fieldName15, Name fieldName16, Name fieldName17, Name fieldName18, Name fieldName19)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList20
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9, Name fieldName10, Name fieldName11, Name fieldName12, Name fieldName13, Name fieldName14, Name fieldName15, Name fieldName16, Name fieldName17, Name fieldName18, Name fieldName19, Name fieldName20)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList21
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9, Name fieldName10, Name fieldName11, Name fieldName12, Name fieldName13, Name fieldName14, Name fieldName15, Name fieldName16, Name fieldName17, Name fieldName18, Name fieldName19, Name fieldName20, Name fieldName21)

Add a list of fields to this name to make this name a DerivedColumnList.

public @NotNull DerivedColumnList22
fields(Name fieldName1, Name fieldName2, Name fieldName3, Name fieldName4, Name fieldName5, Name fieldName6, Name fieldName7, Name fieldName8, Name fieldName9, Name fieldName10, Name fieldName11, Name fieldName12, Name fieldName13, Name fieldName14, Name fieldName15, Name fieldName16, Name fieldName17, Name fieldName18, Name fieldName19, Name fieldName20, Name fieldName21, Name fieldName22)

Add a list of fields to this name to make this name a DerivedColumnList.

public @Nullable String
first()

Get the first segment of the qualified name (usually a Catalog or Schema name).

public @NotNull @NotNull String[]
getName()

The qualified name of this SQL identifier.

public @Nullable String
last()

Get the last segment of the qualified name (usually a Table, Field, or Parameter name).

public @NotNull @NotNull Name[]
parts()

Get the individual, unqualified name parts of this name.

public boolean
qualified()

Whether this is a qualified name.

public @Nullable Name
qualifier()

This name's qualifier (if it is qualified()), or null.

public boolean
qualifierQualified()

Whether this is a qualified name and the qualifier() is also a qualified name.

public @NotNull Name.Quoted
quoted()

Whether this is a quoted name.

public @NotNull Name
quotedName()

This name, quoted.

public @NotNull Name
unqualifiedName()

This name, unqualified.

public @NotNull Name
unquotedName()

This name, unquoted.

Inherited from org.jooq.QueryPart:
hashCodetoString