- All Implemented Interfaces:
Serializable,Fields,Named,Qualified,QueryPart,QueryPartInternal,RecordQualifier<R>,UDT<R>
This type is for JOOQ INTERNAL USE only. Do not reference directly
- Author:
- Lukas Eder
- See Also:
- Serialized Form
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidClause[]Deprecated.- 3.11.0 - [#8179] - This functionality will be removed in the future.protected DSLContextcreate()Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()andConfiguration.dsl()instead.protected DSLContextcreate(Configuration configuration)Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()andConfiguration.dsl()instead.protected DSLContextDeprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()andConfiguration.dsl()instead.createField(String name, DataType<T> type, UDT<R> udt)Deprecated.- 3.12.0 - [#8000] - UsecreateField(Name, DataType, UDT)instead.createField(String name, DataType<T> type, UDT<R> udt, String comment)Deprecated.- 3.12.0 - [#8000] - UsecreateField(Name, DataType, UDT, String)instead.Deprecated.- 3.12.0 - [#8000] - UsecreateField(Name, DataType, UDT, String, Binding)instead.Deprecated.- 3.12.0 - [#8000] - UsecreateField(Name, DataType, UDT, String, Converter)instead.createField(String name, DataType<T> type, UDT<R> udt, String comment, Converter<X,U> converter, Binding<T,X> binding)Deprecated.- 3.12.0 - [#8000] - UsecreateField(Name, DataType, UDT, String, Converter, Binding)instead.createField(Name name, DataType<T> type, UDT<R> udt)Subclasses may call this method to createUDTFieldobjects that are linked to this table.createField(Name name, DataType<T> type, UDT<R> udt, String comment)Subclasses may call this method to createUDTFieldobjects that are linked to this table.Subclasses may call this method to createUDTFieldobjects that are linked to this table.Subclasses may call this method to createUDTFieldobjects that are linked to this table.createField(Name name, DataType<T> type, UDT<R> udt, String comment, Converter<X,U> converter, Binding<T,X> binding)Subclasses may call this method to createUDTFieldobjects that are linked to this table.default DataType<?>dataType(int index)Get the field data type for a given field index, ornullif no field is available at the index.default DataType<?>Get the field data type for a given qualified field name, ornullif no field is known to this type by this name.default DataType<?>Get the field data type for a given qualified field name, ornullif no field is known to this type by this name.default DataType<?>[]Get an array of field data types for this type.booleanSubclasses may override thisbooleanSubclasses may override thisbooleanSubclasses may override thisbooleanSubclasses may override thisbooleanSubclasses may override thisbooleanCheck whether thisQueryPartcan be considered equal to anotherQueryPart.default Field<?>field(int index)Get a field known to this type by index, ornullif no field is available at the index.default <T> Field<T>Get a field known to this type by index coerced totype, ornullif no field is available at the index.default <T> Field<T>Get a field known to this type by index coerced todataType, ornullif no field is available at the index.default Field<?>Deprecated.This method hides static importDSL.field(String).default <T> Field<T>Deprecated.This method hides static importDSL.field(String, Class).default <T> Field<T>Deprecated.This method hides static importDSL.field(String, DataType).default <T> Field<T>Get a field known to this type by field reference.default Field<?>Deprecated.This method hides static importDSL.field(Name).default <T> Field<T>Deprecated.This method hides static importDSL.field(Name, Class).default <T> Field<T>Deprecated.This method hides static importDSL.field(String, DataType).default Field<?>[]fields()Get all fields known to this type.default Field<?>[]fields(int... indexes)Get all fields known to this type, filtering by some field indexes.default Field<?>[]Get all fields known to this type, filtering by some unqualified field names.default Field<?>[]Get all fields, filtering by some fields.default Field<?>[]Get all fields known to this type, filtering by some qualified field names.Get all fields known to this type as aRow.Get all fields known to this type as aStream.booleanSubclasses may override thisGet the object's catalog.The comment on this object.The comment on this object as aQueryPart.getName()The unqualified name of this object.Get the UDT package if this is aUDT, ornullif it is not a UDT, or if it is a schema level UDT defined outside of a package.The qualified name of this object.Subclasses must override this method if they use the generic type parameterfor other types than RecordGet the object's schema.The unqualified name of this object.inthashCode()Generate a hash code from thisQueryPart.default intGet a field's index from this type.default intGet a field's index from this type.default intGet a field's index from this type.booleanWhether this data type can be used from SQL statements.booleanWhether this data type is a synthetic, structural UDT type.booleanrendersContent(Context<?> ctx)Subclasses may override thistoString()Render a SQL string representation of thisQueryPart.protected DataAccessExceptiontranslate(String sql, SQLException e)Internal convenience methoddefault Class<?>type(int index)Get the field type for a given field index, ornullif no field is available at the index.default Class<?>Get the field type for a given unqualified field name, ornullif no field is known to this type by this name.default Class<?>Get the field type for a given qualified field name, ornullif no field is known to this type by this name.default Class<?>[]types()Get an array of field types for fields known to this type.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.jooq.Named
getComment, getCommentPart, getName, getUnqualifiedName
-
Constructor Details
-
UDTImpl
-
UDTImpl
-
UDTImpl
-
-
Method Details
-
getCatalog
Description copied from interface:QualifiedGet the object's catalog.- Specified by:
getCatalogin interfaceQualified
-
getSchema
Description copied from interface:QualifiedGet the object's schema. -
getQualifiedName
Description copied from interface:NamedThe qualified name of this object.- Specified by:
getQualifiedNamein interfaceNamed
-
getPackage
Description copied from interface:RecordQualifierGet the UDT package if this is aUDT, ornullif it is not a UDT, or if it is a schema level UDT defined outside of a package.- Specified by:
getPackagein interfaceRecordQualifier<R extends UDTRecord<R>>
-
fieldsRow
Description copied from interface:FieldsGet all fields known to this type as aRow. -
getRecordType
Subclasses must override this method if they use the generic type parameterfor other types than Record- Specified by:
getRecordTypein interfaceRecordQualifier<R extends UDTRecord<R>>
-
isSQLUsable
public final boolean isSQLUsable()Description copied from interface:UDTWhether this data type can be used from SQL statements.- Specified by:
isSQLUsablein interfaceUDT<R extends UDTRecord<R>>
-
isSynthetic
public final boolean isSynthetic()Description copied from interface:UDTWhether this data type is a synthetic, structural UDT type.This is
truefor example:- For Oracle
TAB%ROWTYPEreferences, which are synthetic PL/SQL RECORD types in PL/SQL.
- Specified by:
isSyntheticin interfaceUDT<R extends UDTRecord<R>>
- For Oracle
-
newRecord
Description copied from interface:RecordQualifier- Specified by:
newRecordin interfaceRecordQualifier<R extends UDTRecord<R>>- See Also:
DSLContext.newRecord(Table)
-
getDataType
Description copied from interface:RecordQualifier- Specified by:
getDataTypein interfaceRecordQualifier<R extends UDTRecord<R>>
-
accept
Description copied from interface:QueryPartInternalThisQueryPartcanacceptaContextobject in order to render a SQL string or to bind its variables.- Specified by:
acceptin interfaceQueryPartInternal
-
createField
@Deprecated protected static final <R extends UDTRecord<R>, T> UDTField<R,T> createField(String name, DataType<T> type, UDT<R> udt)Deprecated.- 3.12.0 - [#8000] - UsecreateField(Name, DataType, UDT)instead.Subclasses may call this method to createUDTFieldobjects that are linked to this table.- Parameters:
name- The name of the field (case-sensitive!)type- The data type of the field
-
createField
@Deprecated protected static final <R extends UDTRecord<R>, T> UDTField<R,T> createField(String name, DataType<T> type, UDT<R> udt, String comment)Deprecated.- 3.12.0 - [#8000] - UsecreateField(Name, DataType, UDT, String)instead.Subclasses may call this method to createUDTFieldobjects that are linked to this table.- Parameters:
name- The name of the field (case-sensitive!)type- The data type of the field
-
createField
@Deprecated protected static final <R extends UDTRecord<R>, T, U> UDTField<R,U> createField(String name, DataType<T> type, UDT<R> udt, String comment, Converter<T,U> converter)Deprecated.- 3.12.0 - [#8000] - UsecreateField(Name, DataType, UDT, String, Converter)instead.Subclasses may call this method to createUDTFieldobjects that are linked to this table.- Parameters:
name- The name of the field (case-sensitive!)type- The data type of the field
-
createField
@Deprecated protected static final <R extends UDTRecord<R>, T, U> UDTField<R,U> createField(String name, DataType<T> type, UDT<R> udt, String comment, Binding<T,U> binding)Deprecated.- 3.12.0 - [#8000] - UsecreateField(Name, DataType, UDT, String, Binding)instead.Subclasses may call this method to createUDTFieldobjects that are linked to this table.- Parameters:
name- The name of the field (case-sensitive!)type- The data type of the field
-
createField
@Deprecated protected static final <R extends UDTRecord<R>, T, X, U> UDTField<R,U> createField(String name, DataType<T> type, UDT<R> udt, String comment, Converter<X,U> converter, Binding<T,X> binding)Deprecated.- 3.12.0 - [#8000] - UsecreateField(Name, DataType, UDT, String, Converter, Binding)instead.Subclasses may call this method to createUDTFieldobjects that are linked to this table.- Parameters:
name- The name of the field (case-sensitive!)type- The data type of the field
-
createField
protected static final <R extends UDTRecord<R>, T> UDTField<R,T> createField(Name name, DataType<T> type, UDT<R> udt)Subclasses may call this method to createUDTFieldobjects that are linked to this table.- Parameters:
name- The name of the field (case-sensitive!)type- The data type of the field
-
createField
protected static final <R extends UDTRecord<R>, T> UDTField<R,T> createField(Name name, DataType<T> type, UDT<R> udt, String comment)Subclasses may call this method to createUDTFieldobjects that are linked to this table.- Parameters:
name- The name of the field (case-sensitive!)type- The data type of the field
-
createField
protected static final <R extends UDTRecord<R>, T, U> UDTField<R,U> createField(Name name, DataType<T> type, UDT<R> udt, String comment, Converter<T,U> converter)Subclasses may call this method to createUDTFieldobjects that are linked to this table.- Parameters:
name- The name of the field (case-sensitive!)type- The data type of the field
-
createField
protected static final <R extends UDTRecord<R>, T, U> UDTField<R,U> createField(Name name, DataType<T> type, UDT<R> udt, String comment, Binding<T,U> binding)Subclasses may call this method to createUDTFieldobjects that are linked to this table.- Parameters:
name- The name of the field (case-sensitive!)type- The data type of the field
-
createField
protected static final <R extends UDTRecord<R>, T, X, U> UDTField<R,U> createField(Name name, DataType<T> type, UDT<R> udt, String comment, Converter<X,U> converter, Binding<T,X> binding)Subclasses may call this method to createUDTFieldobjects that are linked to this table.- Parameters:
name- The name of the field (case-sensitive!)type- The data type of the field
-
fields
Description copied from interface:FieldsGet all fields known to this type. -
fieldStream
Description copied from interface:FieldsGet all fields known to this type as aStream.- Specified by:
fieldStreamin interfaceFields
-
field
Description copied from interface:FieldsGet a field known to this type by field reference.This will return:
- A field that is the same as the argument field (by identity comparison).
- A field that is equal to the argument field (exact matching fully qualified name).
- A field that is equal to the argument field (partially matching qualified name).
- A field whose name is equal to the name of the argument field.
nullotherwise.
-
field
Deprecated.This method hides static importDSL.field(String).Description copied from interface:FieldsGet a field known to this type by unqualified name, ornullif no field is known to this type by this name. -
field
Deprecated.This method hides static importDSL.field(String, Class).Description copied from interface:FieldsGet a field known to this type by unqualified name coerced totype, ornullif no field is known to this type by this name. -
field
Deprecated.This method hides static importDSL.field(String, DataType).Description copied from interface:FieldsGet a field known to this type by unqualified name coerced todataType, ornullif no field is known to this type by this name. -
field
Deprecated.This method hides static importDSL.field(Name).Description copied from interface:FieldsGet a field known to this type by qualified name, ornullif no field is known to this type by this name. -
field
Deprecated.This method hides static importDSL.field(Name, Class).Description copied from interface:FieldsGet a field known to this type by qualified name coerced totype, ornullif no field is known to this type by this name. -
field
Deprecated.This method hides static importDSL.field(String, DataType).Description copied from interface:FieldsGet a field known to this type by qualified name coerced todataType, ornullif no field is known to this type by this name. -
field
Description copied from interface:FieldsGet a field known to this type by index, ornullif no field is available at the index. -
field
Description copied from interface:FieldsGet a field known to this type by index coerced totype, ornullif no field is available at the index. -
field
Description copied from interface:FieldsGet a field known to this type by index coerced todataType, ornullif no field is available at the index. -
fields
Description copied from interface:FieldsGet all fields, filtering by some fields.- Specified by:
fieldsin interfaceFields- Parameters:
fields- The fields to include after looking them up viaFields.field(Field).- See Also:
Fields.field(Field)
-
fields
Description copied from interface:FieldsGet all fields known to this type, filtering by some unqualified field names.- Specified by:
fieldsin interfaceFields- Parameters:
names- The unqualified field names to include after looking them up viaFields.field(String).- See Also:
Fields.field(String)
-
fields
Description copied from interface:FieldsGet all fields known to this type, filtering by some qualified field names.- Specified by:
fieldsin interfaceFields- Parameters:
names- The qualified field names to include after looking them up viaFields.field(Name).- See Also:
Fields.field(Name)
-
fields
Description copied from interface:FieldsGet all fields known to this type, filtering by some field indexes.- Specified by:
fieldsin interfaceFields- See Also:
Fields.field(int)
-
indexOf
Description copied from interface:FieldsGet a field's index from this type. -
indexOf
Description copied from interface:FieldsGet a field's index from this type. -
indexOf
Description copied from interface:FieldsGet a field's index from this type. -
types
Description copied from interface:FieldsGet an array of field types for fields known to this type.Entries in the resulting array correspond to
Typed.getType()for the correspondingFieldinFields.fields() -
type
Description copied from interface:FieldsGet the field type for a given field index, ornullif no field is available at the index. -
type
Description copied from interface:FieldsGet the field type for a given unqualified field name, ornullif no field is known to this type by this name. -
type
Description copied from interface:FieldsGet the field type for a given qualified field name, ornullif no field is known to this type by this name. -
dataTypes
Description copied from interface:FieldsGet an array of field data types for this type.Entries in the resulting array correspond to
Typed.getDataType()for the correspondingFieldinFields.fields() -
dataType
Description copied from interface:FieldsGet the field data type for a given field index, ornullif no field is available at the index. -
dataType
Description copied from interface:FieldsGet the field data type for a given qualified field name, ornullif no field is known to this type by this name. -
dataType
Description copied from interface:FieldsGet the field data type for a given qualified field name, ornullif no field is known to this type by this name. -
getName
Description copied from interface:NamedThe unqualified name of this object. -
getUnqualifiedName
Description copied from interface:NamedThe unqualified name of this object.- Specified by:
getUnqualifiedNamein interfaceNamed
-
getComment
Description copied from interface:NamedThe comment on this object.This is the same as calling
Named.getCommentPart()and thenComment.getComment().- Specified by:
getCommentin interfaceNamed
-
getCommentPart
Description copied from interface:NamedThe comment on this object as aQueryPart.- Specified by:
getCommentPartin interfaceNamed
-
hashCode
public int hashCode()Description copied from interface:QueryPartGenerate a hash code from thisQueryPart.In general,
QueryParthash codes are the same as the hash codes generated fromQueryPart.toString(). This guarantees consistent behaviour withQueryPart.equals(Object)Some
QueryPartimplementations may choose to override this behaviour for improved performance, asQueryPart.toString()is an expensive operation, if called many times. -
equals
Description copied from interface:QueryPartCheck whether thisQueryPartcan be considered equal to anotherQueryPart.In general,
QueryPartequality is defined in terms ofQueryPart.toString()equality. In other words, two query parts are considered equal if their rendered SQL (with inlined bind variables) is equal. This means that the two query parts do not necessarily have to be of the same type.Some
QueryPartimplementations may choose to override this behaviour for improved performance, asQueryPart.toString()is an expensive operation, if called many times. -
clauses
Deprecated.- 3.11.0 - [#8179] - This functionality will be removed in the future.Description copied from interface:QueryPartInternalTheClauses that are represented by this query part.QueryParts can specify severalClauses for which an event will be emittedbefore(in forward order) andafter(in reverse order) visiting the the query part throughContext.visit(QueryPart)This method is for JOOQ INTERNAL USE only. Do not reference directly
- Specified by:
clausesin interfaceQueryPartInternal- Returns:
- The
Clauses represented by this query part ornullor an empty array if this query part does not represent a clause.
-
rendersContent
Subclasses may override this- Specified by:
rendersContentin interfaceQueryPartInternal
-
declaresFields
public boolean declaresFields()Subclasses may override this- Specified by:
declaresFieldsin interfaceQueryPartInternal
-
declaresTables
public boolean declaresTables()Subclasses may override this- Specified by:
declaresTablesin interfaceQueryPartInternal
-
declaresWindows
public boolean declaresWindows()Subclasses may override this- Specified by:
declaresWindowsin interfaceQueryPartInternal
-
declaresCTE
public boolean declaresCTE()Subclasses may override this- Specified by:
declaresCTEin interfaceQueryPartInternal
-
declaresParameters
Subclasses may override this- Specified by:
declaresParametersin interfaceQueryPartInternal
-
generatesCast
public boolean generatesCast()Subclasses may override this- Specified by:
generatesCastin interfaceQueryPartInternal
-
toString
Description copied from interface:QueryPartRender a SQL string representation of thisQueryPart.For improved debugging, this renders a SQL string of this
QueryPartwith inlined bind variables. If thisQueryPartisAttachable, then the attachedConfigurationmay be used for rendering the SQL string, includingSQLDialectandSettings. Do note that mostQueryPartinstances are not attached to aConfiguration, and thus there is no guarantee that the SQL string will make sense in the context of a specific database. -
create
Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()andConfiguration.dsl()instead.Internal convenience method -
create
Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()andConfiguration.dsl()instead.Internal convenience method -
create
Deprecated.- 3.11.0 - [#6722] - UseAttachable.configuration()andConfiguration.dsl()instead.Internal convenience method -
translate
Internal convenience method
-