trait GeneratorConfiguration extends AnyRef
Basic and advanced configuration options that can be modified without extending the generator class.
In most cases, extend DefaultGeneratorConfiguration instead of this trait directly.
- Alphabetic
- By Inheritance
- GeneratorConfiguration
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
basePackage: String
The base package of all compilation units, which is basically concatenated with each unit's name.
-
abstract
def
db: DatabaseConfiguration
The DatabaseConfiguration used to access your local database.
-
abstract
def
ignoredTables: Set[String]
Names of all tables that should be ignored during code generation.
-
abstract
def
imports: Set[Import]
A set of imported classes and packages which will be accessible by simple name in the generated code.
-
abstract
def
namingStrategy: NamingStrategy
The naming strategy turns SQL names into Scala names for tables and columns (classes and attributes).
The naming strategy turns SQL names into Scala names for tables and columns (classes and attributes). You can use one of the provided naming strategies or implement your own.
-
abstract
def
scalafmtConfig: Option[Path]
A Path to your scalafmt configuration file or None if no code formatting is desired.
-
abstract
def
schemaReader: SchemaReader
The schema reader fetches the schema from the database and transforms it into a schema model.
The schema reader fetches the schema from the database and transforms it into a schema model. You generally don't need to override this, but the option is there just in case.
-
abstract
def
selectCompanionEmitter(table: Table): CompanionEmitter
Selects the companion emitter based on the given table (and possibly the schema).
-
abstract
def
selectModelEmitter(table: Table): ModelEmitter
Selects the model emitter based on the given table (and possibly the schema).
-
abstract
def
selectPropertyEmitter(column: Column): PropertyEmitter
Selects the property emitter based on the given column (and possibly the table and even schema).
-
abstract
def
selectSchemaEmitter(schema: Schema): SchemaEmitter
Selects the schema emitter based on the given schema.
-
abstract
def
sourceSchema: String
The name of the schema used as the basis for code generation.
-
abstract
def
targetFolder: Path
The target folder where the root folder of the base package will be placed.
The target folder where the root folder of the base package will be placed.
For example, assume the base package is
com.example, we have one compilation unit with a nameschema.Schema, and the target folder istarget/scala-2.12/src_managed. Generator will write the compilation unit to the filetarget/scala-2.12/src_managed/com/example/schema/Schema.scala. -
abstract
def
typeEmitter: TypeEmitter
The type emitter can be overridden to change how types, type names and/or column types are emitted.
-
abstract
def
typeResolver: TypeResolver
The type resolver translates JDBC types to Scala types.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )