Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.tool.schema.Action

Field Summary

Modifier and Type	Field and Description
public static final String	ACTION_CREATE
public static final String	ACTION_CREATE_ONLY
public static final String	ACTION_CREATE_THEN_DROP
public static final String	ACTION_DROP
public static final String	ACTION_NONE
public static final String	ACTION_UPDATE
public static final String	ACTION_VALIDATE
public static final Action	CREATE Drop and then recreate the schema.
public static final Action	CREATE_DROP Drop the schema and then recreate it on `SessionFactory` startup.
public static final Action	CREATE_ONLY Create the schema.
public static final Action	DROP Drop the schema.
public static final Action	NONE No action.
public static final String	SPEC_ACTION_CREATE
public static final String	SPEC_ACTION_DROP
public static final String	SPEC_ACTION_DROP_AND_CREATE
public static final String	SPEC_ACTION_NONE
public static final Action	TRUNCATE Truncate the tables in the schema.
public static final Action	UPDATE Update (alter) the database schema.
public static final Action	VALIDATE Validate the database schema.

Access	Constructor and Description
private	Action()

Method Summary

Modifier and Type	Method and Description
public String	getExternalHbm2ddlName() The string configuration value identifying this action in old-school Hibernate configuration via hibernate.hbm2ddl.auto.
public String	getExternalJpaName() The string configuration value identifying this action in JPA-standard configuration via jakarta.persistence.schema-generation.database.action or jakarta.persistence.schema-generation.scripts.action.
public static Action	Returns: The matching enum value. An empty value will return `NONE`. interpretHbm2ddlSetting(Object The encountered config value value) Interpret the value of the old-school Hibernate configuration property hibernate.hbm2ddl.auto as an instance of `Action`.
public static Action	Returns: The matching enum value. An empty value will return `NONE`. interpretJpaSetting(Object The encountered config value value) Interpret the value of the JPA-standard configuration property jakarta.persistence.schema-generation.database.action or jakarta.persistence.schema-generation.scripts.action as an instance of `Action`.
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static Action	valueOf(String name)
public static Action[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

ACTION_CREATE	back to summary
public static final String ACTION_CREATE See Also `CREATE`

ACTION_CREATE_ONLY	back to summary
public static final String ACTION_CREATE_ONLY See Also `CREATE_ONLY`

ACTION_CREATE_THEN_DROP	back to summary
public static final String ACTION_CREATE_THEN_DROP See Also `CREATE_DROP`

ACTION_DROP	back to summary
public static final String ACTION_DROP See Also `DROP`

ACTION_NONE	back to summary
public static final String ACTION_NONE See Also `NONE`

ACTION_UPDATE	back to summary
public static final String ACTION_UPDATE See Also `UPDATE`

ACTION_VALIDATE	back to summary
public static final String ACTION_VALIDATE See Also `VALIDATE`

CREATE back to summary

CREATE	back to summary
public static final Action CREATE Drop and then recreate the schema. API Note This action is called `"drop-and-create"` by JPA, but simply `"create"` by the legacy HBM2DDL tool. See Also `org.hibernate.tool.schema.spi.SchemaDropper`, `org.hibernate.tool.schema.spi.SchemaCreator`

public static final Action CREATE

Drop and then recreate the schema.

API Note

This action is called "drop-and-create" by JPA, but simply "create" by the legacy HBM2DDL tool.

See Also: org.hibernate.tool.schema.spi.SchemaDropper, org.hibernate.tool.schema.spi.SchemaCreator

CREATE_DROP back to summary

CREATE_DROP	back to summary
public static final Action CREATE_DROP Drop the schema and then recreate it on `SessionFactory` startup. Additionally, drop the schema on `SessionFactory` shutdown. While this is a valid option for auto schema tooling, it's not a valid action for the `SchemaManagementTool`; instead the caller of `SchemaManagementTool` must split this into two separate requests to: drop and create the schema, and then later, drop the schema again. API Note This action is not defined by JPA. See Also `org.hibernate.tool.schema.spi.SchemaDropper`, `org.hibernate.tool.schema.spi.SchemaCreator`

public static final Action CREATE_DROP

Drop the schema and then recreate it on SessionFactory startup. Additionally, drop the schema on SessionFactory shutdown.

While this is a valid option for auto schema tooling, it's not a valid action for the SchemaManagementTool; instead the caller of SchemaManagementTool must split this into two separate requests to:

drop and create the schema, and then
later, drop the schema again.

API Note

This action is not defined by JPA.

See Also: org.hibernate.tool.schema.spi.SchemaDropper, org.hibernate.tool.schema.spi.SchemaCreator

CREATE_ONLY back to summary

CREATE_ONLY	back to summary
public static final Action CREATE_ONLY Create the schema. API Note This is an action introduced by JPA; the legacy HBM2DDL tool had no such action. Its action named `"create"` was equivalent to `CREATE`. See Also `org.hibernate.tool.schema.spi.SchemaCreator`

public static final Action CREATE_ONLY

Create the schema.

API Note

This is an action introduced by JPA; the legacy HBM2DDL tool had no such action. Its action named "create" was equivalent to CREATE.

See Also: org.hibernate.tool.schema.spi.SchemaCreator

DROP back to summary

DROP	back to summary
public static final Action DROP Drop the schema. API Note Valid in JPA; identical to the HBM2DDL action of the same name. See Also `org.hibernate.tool.schema.spi.SchemaDropper`

public static final Action DROP

Drop the schema.

API Note

Valid in JPA; identical to the HBM2DDL action of the same name.

See Also: org.hibernate.tool.schema.spi.SchemaDropper

NONE	back to summary
public static final Action NONE No action. API Note Valid in JPA; identical to the HBM2DDL action of the same name.

SPEC_ACTION_CREATE	back to summary
public static final String SPEC_ACTION_CREATE See Also `CREATE_ONLY`

SPEC_ACTION_DROP	back to summary
public static final String SPEC_ACTION_DROP See Also `DROP`

SPEC_ACTION_DROP_AND_CREATE	back to summary
public static final String SPEC_ACTION_DROP_AND_CREATE See Also `CREATE`

SPEC_ACTION_NONE	back to summary
public static final String SPEC_ACTION_NONE See Also `NONE`

TRUNCATE back to summary

TRUNCATE	back to summary
public static final Action TRUNCATE Truncate the tables in the schema. API Note This action is not defined by JPA. Since 6.2 See Also `org.hibernate.tool.schema.spi.SchemaTruncator`

public static final Action TRUNCATE

Truncate the tables in the schema.

API Note

This action is not defined by JPA.

Since: 6.2
See Also: org.hibernate.tool.schema.spi.SchemaTruncator

UPDATE back to summary

UPDATE	back to summary
public static final Action UPDATE Update (alter) the database schema. API Note This action is not defined by JPA. See Also `org.hibernate.tool.schema.spi.SchemaMigrator`

public static final Action UPDATE

Update (alter) the database schema.

API Note

This action is not defined by JPA.

See Also: org.hibernate.tool.schema.spi.SchemaMigrator

VALIDATE back to summary

VALIDATE	back to summary
public static final Action VALIDATE Validate the database schema. API Note This action is not defined by JPA. See Also `org.hibernate.tool.schema.spi.SchemaValidator`

public static final Action VALIDATE

Validate the database schema.

API Note

This action is not defined by JPA.

See Also: org.hibernate.tool.schema.spi.SchemaValidator

Constructor Detail

Action	back to summary
private Action()

Method Detail

getExternalHbm2ddlName	back to summary
public String getExternalHbm2ddlName() The string configuration value identifying this action in old-school Hibernate configuration via hibernate.hbm2ddl.auto.

getExternalJpaName	back to summary
public String getExternalJpaName() The string configuration value identifying this action in JPA-standard configuration via jakarta.persistence.schema-generation.database.action or jakarta.persistence.schema-generation.scripts.action.

interpretHbm2ddlSetting back to summary

interpretHbm2ddlSetting	back to summary
public static Action interpretHbm2ddlSetting(Object value) Interpret the value of the old-school Hibernate configuration property hibernate.hbm2ddl.auto as an instance of `Action`. Parameters value:Object The encountered config value Returns:Action The matching enum value. An empty value will return `NONE`. Exceptions IllegalArgumentException: If the incoming value is unrecognized

public static Action interpretHbm2ddlSetting(Object value)

Interpret the value of the old-school Hibernate configuration property hibernate.hbm2ddl.auto as an instance of Action.

Parameters

value:Object: The encountered config value

Returns:Action

The matching enum value. An empty value will return NONE.

Exceptions

IllegalArgumentException:: If the incoming value is unrecognized

interpretJpaSetting back to summary

interpretJpaSetting	back to summary
public static Action interpretJpaSetting(Object value) Interpret the value of the JPA-standard configuration property jakarta.persistence.schema-generation.database.action or jakarta.persistence.schema-generation.scripts.action as an instance of `Action`. Parameters value:Object The encountered config value Returns:Action The matching enum value. An empty value will return `NONE`. Exceptions IllegalArgumentException: If the incoming value is unrecognized

public static Action interpretJpaSetting(Object value)

Interpret the value of the JPA-standard configuration property jakarta.persistence.schema-generation.database.action or jakarta.persistence.schema-generation.scripts.action as an instance of Action.

Parameters

value:Object: The encountered config value

Returns:Action

The matching enum value. An empty value will return NONE.

Exceptions

IllegalArgumentException:: If the incoming value is unrecognized

toString	back to summary
public String toString() Overrides java.lang.Enum.toString. Doc from java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. Returns:String the name of this enum constant Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations

@Override

valueOf	back to summary
public static Action valueOf(String name)

values	back to summary
public static Action[] values()

public final Enum Action

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail