Package org.hibernate.cfg

Interface MultiTenancySettings

All Known Subinterfaces:

AvailableSettings

All Known Implementing Classes:

Environment

public interface MultiTenancySettings

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MULTI_TENANT_CONNECTION_PROVIDER	Specifies a MultiTenantConnectionProvider to use.
static final String	MULTI_TENANT_IDENTIFIER_RESOLVER	Specifies a CurrentTenantIdentifierResolver to use, either: an instance of CurrentTenantIdentifierResolver, a Class representing a class that implements CurrentTenantIdentifierResolver, or the name of a class that implements CurrentTenantIdentifierResolver.
static final String	MULTI_TENANT_SCHEMA_MAPPER	Specifies a TenantSchemaMapper to use, either: an instance of TenantSchemaMapper, a Class representing a class that implements TenantSchemaMapper, or the name of a class that implements TenantSchemaMapper.
static final String	TENANT_IDENTIFIER_TO_USE_FOR_ANY_KEY	During bootstrap, Hibernate needs access to a Connection for access to the DatabaseMetaData.

Field Details

MULTI_TENANT_CONNECTION_PROVIDER

static final String MULTI_TENANT_CONNECTION_PROVIDER

Specifies a MultiTenantConnectionProvider to use. Since MultiTenantConnectionProvider is also a service, it may be configured directly via the StandardServiceRegistryBuilder.

Since:

4.1

See Also:

• Constant Field Values

MULTI_TENANT_IDENTIFIER_RESOLVER

static final String MULTI_TENANT_IDENTIFIER_RESOLVER

Specifies a CurrentTenantIdentifierResolver to use, either:

• an instance of CurrentTenantIdentifierResolver,
• a Class representing a class that implements CurrentTenantIdentifierResolver, or
• the name of a class that implements CurrentTenantIdentifierResolver.

Since:

4.1

See Also:

• CurrentTenantIdentifierResolver
• SessionFactoryBuilder.applyCurrentTenantIdentifierResolver(org.hibernate.context.spi.CurrentTenantIdentifierResolver<?>)
• Constant Field Values

TENANT_IDENTIFIER_TO_USE_FOR_ANY_KEY

static final String TENANT_IDENTIFIER_TO_USE_FOR_ANY_KEY

During bootstrap, Hibernate needs access to a Connection for access to the DatabaseMetaData. This setting configures the tenant id to use when obtaining the DataSource to use for this access.

See Also:

• Constant Field Values

MULTI_TENANT_SCHEMA_MAPPER

static final String MULTI_TENANT_SCHEMA_MAPPER

Specifies a TenantSchemaMapper to use, either:

• an instance of TenantSchemaMapper,
• a Class representing a class that implements TenantSchemaMapper, or
• the name of a class that implements TenantSchemaMapper.

When a tenant schema mapper is set, Connection.setSchema(String)} is called on newly acquired JDBC connections with the schema name returned by TenantSchemaMapper.schemaName(T).

By default, there is no tenant schema mapper.

Since:

7.1

See Also:

• TenantSchemaMapper
• SessionFactoryBuilder.applyTenantSchemaMapper(org.hibernate.context.spi.TenantSchemaMapper<?>)
• Constant Field Values