org.jooq
Class SchemaMapping

java.lang.Object
  org.jooq.SchemaMapping

All Implemented Interfaces:

Serializable

public class SchemaMapping
extends Object
implements Serializable

General mapping of generated artefacts onto run-time substitutes.

There are several use cases, when the run-time schema configuration may be different from the compile-time (or code-generation-time) schema configuration. Say, you develop a schema called DEV. It contains a table DEV.T. When you install your database on a productive system, you might have two schemata:

• PROD: The productive schema. It contains the table PROD.T
• BACKUP: The productive backup schema. This schema might be shared with other applications, so you might have table name collisions. Therefore, you'd want to map your table DEV.T onto BACKUP.MY_T

This can be achieved with the SchemaMapping, where you can map schemata and tables, for them to render different names at run-time, than at compile-time.

Since:

1.5.2, 1.6.0

Author:

Lukas Eder

See Also:

https://sourceforge.net/apps/trac/jooq/wiki/Manual/ADVANCED/SchemaMapping, Serialized Form

Field Summary

static SchemaMapping

NO_MAPPING The default, unmodifiable mapping that just takes generated schemata

Constructor Summary

SchemaMapping()
Construct an empty mapping

Method Summary

void	add(Schema generatedSchema, Schema configuredSchema) Add schemata to this mapping
void	add(Schema generatedSchema, String configuredSchemaName) Add schemata to this mapping
void	add(Table<?> generatedTable, String configuredTableName) Add tables to this mapping
void	add(Table<?> generatedTable, Table<?> configuredTable) Add tables to this mapping
Schema	map(Schema generatedSchema) Apply mapping to a given schema
Table<?>	map(Table<?> generatedTable) Apply mapping to a given table
void	setDefaultSchema(String schema) Synonym for use(String).
void	setSchemaMapping(Map<String,String> schemaMap) Initialise SchemaMapping.
String	toString()
void	use(Schema schema) Set a schema as the default schema.
void	use(String schemaName) Set a schema as the default schema.

Methods inherited from class java.lang.Object

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

Field Detail

NO_MAPPING

public static final SchemaMapping NO_MAPPING

The default, unmodifiable mapping that just takes generated schemata

Constructor Detail

SchemaMapping

public SchemaMapping()

Construct an empty mapping

Method Detail

use

public void use(Schema schema)

Set a schema as the default schema. This results in the supplied schema being omitted in generated SQL.

If the supplied mapping has already been added using add(Schema, Schema), then use() has no effect.

Parameters:

schema - the default schema

use

public void use(String schemaName)

Set a schema as the default schema. This results in the supplied schema being omitted in generated SQL.

If the supplied mapping has already been added using add(Schema, Schema), then use() has no effect.

Parameters:

schemaName - the default schema

add

public void add(Schema generatedSchema,
                Schema configuredSchema)

Add schemata to this mapping

Parameters:

generatedSchema - The schema known at codegen time to be mapped

configuredSchema - The schema configured at run time to be mapped

add

public void add(Schema generatedSchema,
                String configuredSchemaName)

Add schemata to this mapping

Parameters:

generatedSchema - The schema known at codegen time to be mapped

configuredSchemaName - The schema configured at run time to be mapped

add

public void add(Table<?> generatedTable,
                Table<?> configuredTable)

Add tables to this mapping

Parameters:

generatedTable - The table known at codegen time to be mapped

configuredTable - The table configured at run time to be mapped

add

public void add(Table<?> generatedTable,
                String configuredTableName)

Add tables to this mapping

Parameters:

generatedTable - The table known at codegen time to be mapped

configuredTableName - The table configured at run time to be mapped

map

public Schema map(Schema generatedSchema)

Apply mapping to a given schema

Parameters:

generatedSchema - The generated schema to be mapped

Returns:

The configured schema

map

public Table<?> map(Table<?> generatedTable)

Apply mapping to a given table

Parameters:

generatedTable - The generated table to be mapped

Returns:

The configured table

setDefaultSchema

public void setDefaultSchema(String schema)

Synonym for use(String). Added for better interoperability with Spring

setSchemaMapping

public void setSchemaMapping(Map<String,String> schemaMap)

Initialise SchemaMapping. Added for better interoperability with Spring

toString

public String toString()

Overrides:

toString in class Object