Package org.keycloak.models.map.storage.jpa.updater

Interface MapJpaUpdaterProvider

All Superinterfaces:

org.keycloak.provider.Provider

All Known Implementing Classes:

MapJpaLiquibaseUpdaterProvider

public interface MapJpaUpdaterProvider
extends org.keycloak.provider.Provider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	MapJpaUpdaterProvider.Status	Status of database up-to-dateness

Method Summary

Modifier and Type	Method	Description
void	export(Class<?> modelType, Connection connection, String defaultSchema, File file)	Exports the SQL update script for the given model type into the given File.
String	getDatabaseShortName()	Returns an all-lower-case short name of the used database.
void	update(Class<?> modelType, Connection connection, String defaultSchema)	Updates the Keycloak database for the given model type
MapJpaUpdaterProvider.Status	validate(Class<?> modelType, Connection connection, String defaultSchema)	Checks whether Keycloak database for the given model type is up to date with the most recent changesets

Methods inherited from interface org.keycloak.provider.Provider

close

Method Details

update

void update(Class<?> modelType,
 Connection connection,
 String defaultSchema)

Updates the Keycloak database for the given model type

Parameters:

modelType - Model type

connection - DB connection

defaultSchema - DB connection

validate

MapJpaUpdaterProvider.Status validate(Class<?> modelType,
 Connection connection,
 String defaultSchema)

Checks whether Keycloak database for the given model type is up to date with the most recent changesets

Parameters:

modelType - Model type

connection - DB connection

defaultSchema - DB schema to use

Returns:

export

void export(Class<?> modelType,
 Connection connection,
 String defaultSchema,
 File file)

Exports the SQL update script for the given model type into the given File.

Parameters:

modelType - Model type

connection - DB connection

defaultSchema - DB schema to use

file - File to write to

getDatabaseShortName

String getDatabaseShortName()

Returns an all-lower-case short name of the used database.