Top Description Methods
org.jooq

public Interface Version

extends Node<Version>
Known Direct Implementers
org.jooq.impl.VersionImpl
Annotations
@Experimental
Imports
java.util.Collection, .List, org.jooq.conf.Settings, org.jetbrains.annotations.NotNull, .ApiStatus.Experimental
A version ID attached to a Meta description of a database.

This is EXPERIMENTAL functionality and subject to change in future jOOQ versions.

Author
Lukas Eder

Method Summary

Modifier and TypeMethod and Description
public @NotNull Version
apply(String id, Queries migration)

Apply a migration to produce a new version.

public @NotNull Version
apply(String id, Query... migration)

Apply a migration to produce a new version.

public @NotNull Version
apply(String id, Collection<? extends Query> migration)

Apply a migration to produce a new version.

public @NotNull Version
apply(String id, String migration)

Apply a migration to produce a new version.

public @NotNull Version
commit(String id, Meta meta)

Commit a new Meta representation to the version graph.

public @NotNull Version
commit(String id, String... meta)

Commit a new Meta representation to the version graph.

public @NotNull Version
commit(String id, Source... meta)

Commit a new Meta representation to the version graph.

public @NotNull Version
merge(String id, Version with)

Merge versions.

public @NotNull Meta
meta()

The version's Meta representation of the database.

public @NotNull Queries
migrateTo(Version version)

Produce a migration to a new version.

Inherited from org.jooq.Node:
idmessageparentsroot

Method Detail

applyback to summary
public @NotNull Version apply(String id, Queries migration)

Apply a migration to produce a new version.

Annotations
@NotNull
applyback to summary
public @NotNull Version apply(String id, Query... migration)

Apply a migration to produce a new version.

Annotations
@NotNull
See Also
apply(String, Queries)
applyback to summary
public @NotNull Version apply(String id, Collection<? extends Query> migration)

Apply a migration to produce a new version.

Annotations
@NotNull
See Also
apply(String, Queries)
applyback to summary
public @NotNull Version apply(String id, String migration)

Apply a migration to produce a new version.

Annotations
@NotNull
See Also
apply(String, Queries)
commitback to summary
public @NotNull Version commit(String id, Meta meta)

Commit a new Meta representation to the version graph.

This calculates a migration path using Meta#migrateTo(Meta).

Annotations
@NotNull
commitback to summary
public @NotNull Version commit(String id, String... meta)

Commit a new Meta representation to the version graph.

Annotations
@NotNull
See Also
commit(String, Meta)
commitback to summary
public @NotNull Version commit(String id, Source... meta)

Commit a new Meta representation to the version graph.

Annotations
@NotNull
See Also
commit(String, Meta)
mergeback to summary
public @NotNull Version merge(String id, Version with)

Merge versions.

Annotations
@NotNull
metaback to summary
public @NotNull Meta meta()

The version's Meta representation of the database.

Annotations
@NotNull
migrateToback to summary
public @NotNull Queries migrateTo(Version version)

Produce a migration to a new version.

In jOOQ's commercial distributions, this method allows for migrating between versions in any direction, regardless of which version was "first" in a version graph, or if the two versions are on different branches. The resulting queries are potentially destructive in such a case. Such destructive queries ("UNDO" migrations) are prevented by default, and can be turned on using Settings#isMigrationAllowsUndo().

In jOOQ's Open Source Edition, this method only allows for migrating "forward".

Annotations
@NotNull