Package org.keycloak.connections.jpa.updater.liquibase

Class LiquibaseJpaUpdaterProvider

java.lang.Object

org.keycloak.connections.jpa.updater.liquibase.LiquibaseJpaUpdaterProvider

All Implemented Interfaces:

JpaUpdaterProvider, Provider

public class LiquibaseJpaUpdaterProvider
extends Object
implements JpaUpdaterProvider

Author:

Stian Thorgersen

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.connections.jpa.updater.JpaUpdaterProvider

JpaUpdaterProvider.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGELOG
static final String	DEPLOYMENT_ID_COLUMN

Constructor Summary

Constructors

Constructor	Description
LiquibaseJpaUpdaterProvider(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
void	close()
void	export(Connection connection, String defaultSchema, File file)	Exports the SQL update script into the given File.
static String	getTable(String table, String defaultSchema)
void	update(Connection connection, String defaultSchema)	Updates the Keycloak database
protected void	updateChangeSet(KeycloakLiquibase liquibase, Writer exportWriter)
JpaUpdaterProvider.Status	validate(Connection connection, String defaultSchema)	Checks whether Keycloak database is up to date with the most recent changesets
protected JpaUpdaterProvider.Status	validateChangeSet(KeycloakLiquibase liquibase, String changelog)
protected JpaUpdaterProvider.Status	validateSynch(Connection connection, String defaultSchema)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CHANGELOG

public static final String CHANGELOG

See Also:

• Constant Field Values

DEPLOYMENT_ID_COLUMN

public static final String DEPLOYMENT_ID_COLUMN

See Also:

• Constant Field Values

Constructor Details

LiquibaseJpaUpdaterProvider

public LiquibaseJpaUpdaterProvider(KeycloakSession session)

Method Details

update

public void update(Connection connection,
 String defaultSchema)

Description copied from interface: JpaUpdaterProvider

Updates the Keycloak database

Specified by:

update in interface JpaUpdaterProvider

Parameters:

connection - DB connection

defaultSchema - DB connection

export

public void export(Connection connection,
 String defaultSchema,
 File file)

Description copied from interface: JpaUpdaterProvider

Exports the SQL update script into the given File.

Specified by:

export in interface JpaUpdaterProvider

Parameters:

connection - DB connection

defaultSchema - DB schema to use

file - File to write to

updateChangeSet

protected void updateChangeSet(KeycloakLiquibase liquibase,
 Writer exportWriter)
                        throws liquibase.exception.LiquibaseException,
SQLException

Throws:

liquibase.exception.LiquibaseException

SQLException

validate

public JpaUpdaterProvider.Status validate(Connection connection,
 String defaultSchema)

Description copied from interface: JpaUpdaterProvider

Checks whether Keycloak database is up to date with the most recent changesets

Specified by:

validate in interface JpaUpdaterProvider

Parameters:

connection - DB connection

defaultSchema - DB schema to use

Returns:

validateSynch

protected JpaUpdaterProvider.Status validateSynch(Connection connection,
 String defaultSchema)

validateChangeSet

protected JpaUpdaterProvider.Status validateChangeSet(KeycloakLiquibase liquibase,
 String changelog)
                                               throws liquibase.exception.LiquibaseException

Throws:

liquibase.exception.LiquibaseException

close

public void close()

Specified by:

close in interface Provider

getTable

public static String getTable(String table,
 String defaultSchema)