Config Options for ktorm-schema

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

OptionDescriptionValuesDefault
addSurrogateKeyAdds the surrogate key for all models that don't already have a primary key (named by the above convention)false
artifactIdGenerated artifact id (name of jar).ktorm
artifactVersionGenerated artifact's package version.1.0.0
defaultDatabaseNameDefault database name for all queriessqlite.db
enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'camelCase
groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
identifierNamingConventionNaming convention of Ktorm identifiers(table names and column names). This is not related to database name which is defined by defaultDatabaseName option
original
Do not transform original names
snake_case
Use snake_case names
original
importModelPackageNamePackage name of the imported modelsorg.openapitools.database.models
modelMutableCreate mutable modelsfalse
packageNameGenerated artifact package name.org.openapitools.database
primaryKeyConventionPrimary key naming conventionid
sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
sourceFoldersource folder for generated codesrc/main/kotlin

IMPORT MAPPING

Type/AliasImports
BigDecimaljava.math.BigDecimal
Datejava.util.Date
DateTimejava.time.LocalDateTime
Filejava.io.File
LocalDatejava.time.LocalDate
LocalDateTimejava.time.LocalDateTime
LocalTimejava.time.LocalTime
Timestampjava.sql.Timestamp
URIjava.net.URI
UUIDjava.util.UUID

INSTANTIATION TYPES

Type/AliasInstantiated By
arraykotlin.collections.ArrayList
listkotlin.collections.ArrayList
mapkotlin.collections.HashMap

LANGUAGE PRIMITIVES

  • kotlin.Array
  • kotlin.Boolean
  • kotlin.Byte
  • kotlin.ByteArray
  • kotlin.Char
  • kotlin.Double
  • kotlin.Float
  • kotlin.Int
  • kotlin.Long
  • kotlin.Short
  • kotlin.String
  • kotlin.collections.List
  • kotlin.collections.Map
  • kotlin.collections.Set

RESERVED WORDS

  • abort
  • action
  • add
  • after
  • all
  • alter
  • always
  • analyze
  • and
  • any
  • as
  • asc
  • attach
  • autoincr
  • autoincrement
  • before
  • begin
  • between
  • bitand
  • bitnot
  • bitor
  • blob
  • by
  • cascade
  • case
  • cast
  • check
  • collate
  • column
  • comma
  • commit
  • concat
  • conflict
  • constraint
  • create
  • cross
  • current
  • current_date
  • current_time
  • current_timestamp
  • database
  • default
  • deferrable
  • deferred
  • delete
  • desc
  • detach
  • distinct
  • do
  • dot
  • drop
  • each
  • else
  • end
  • eq
  • escape
  • except
  • exclude
  • exclusive
  • exists
  • explain
  • fail
  • filter
  • first
  • float
  • following
  • for
  • foreign
  • from
  • full
  • ge
  • generated
  • glob
  • group
  • groups
  • gt
  • having
  • id
  • if
  • ignore
  • immediate
  • in
  • index
  • indexed
  • initially
  • inner
  • insert
  • instead
  • integer
  • intersect
  • into
  • is
  • isnull
  • join
  • key
  • last
  • le
  • left
  • like
  • limit
  • lp
  • lshift
  • lt
  • match
  • minus
  • natural
  • ne
  • no
  • not
  • nothing
  • notnull
  • null
  • nulls
  • of
  • offset
  • on
  • or
  • order
  • others
  • outer
  • over
  • partition
  • plan
  • plus
  • pragma
  • preceding
  • primary
  • query
  • raise
  • range
  • recursive
  • references
  • regexp
  • reindex
  • release
  • rem
  • rename
  • replace
  • restrict
  • right
  • rollback
  • row
  • rows
  • rp
  • rshift
  • savepoint
  • select
  • set
  • slash
  • star
  • string
  • table
  • temp
  • temporary
  • then
  • ties
  • to
  • transaction
  • trigger
  • unbounded
  • union
  • unique
  • update
  • using
  • vacuum
  • values
  • variable
  • view
  • virtual
  • when
  • where
  • window
  • with
  • without

FEATURE SET

Client Modification Feature

NameSupportedDefined By
BasePathToolingExtension
AuthorizationsToolingExtension
UserAgentToolingExtension
MockServerToolingExtension

Data Type Feature

NameSupportedDefined By
CustomOAS2,OAS3
Int32OAS2,OAS3
Int64OAS2,OAS3
FloatOAS2,OAS3
DoubleOAS2,OAS3
DecimalToolingExtension
StringOAS2,OAS3
ByteOAS2,OAS3
BinaryOAS2,OAS3
BooleanOAS2,OAS3
DateOAS2,OAS3
DateTimeOAS2,OAS3
PasswordOAS2,OAS3
FileOAS2
ArrayOAS2,OAS3
MapsToolingExtension
CollectionFormatOAS2
CollectionFormatMultiOAS2
EnumOAS2,OAS3
ArrayOfEnumToolingExtension
ArrayOfModelToolingExtension
ArrayOfCollectionOfPrimitivesToolingExtension
ArrayOfCollectionOfModelToolingExtension
ArrayOfCollectionOfEnumToolingExtension
MapOfEnumToolingExtension
MapOfModelToolingExtension
MapOfCollectionOfPrimitivesToolingExtension
MapOfCollectionOfModelToolingExtension
MapOfCollectionOfEnumToolingExtension

Documentation Feature

NameSupportedDefined By
ReadmeToolingExtension
ModelToolingExtension
ApiToolingExtension

Global Feature

NameSupportedDefined By
HostOAS2,OAS3
BasePathOAS2,OAS3
InfoOAS2,OAS3
SchemesOAS2,OAS3
PartialSchemesOAS2,OAS3
ConsumesOAS2
ProducesOAS2
ExternalDocumentationOAS2,OAS3
ExamplesOAS2,OAS3
XMLStructureDefinitionsOAS2,OAS3
MultiServerOAS3
ParameterizedServerOAS3
ParameterStylingOAS3
CallbacksOAS3
LinkObjectsOAS3

Parameter Feature

NameSupportedDefined By
PathOAS2,OAS3
QueryOAS2,OAS3
HeaderOAS2,OAS3
BodyOAS2
FormUnencodedOAS2
FormMultipartOAS2
CookieOAS3

Schema Support Feature

NameSupportedDefined By
SimpleOAS2,OAS3
CompositeOAS2,OAS3
PolymorphismOAS2,OAS3
UnionOAS3

Security Feature

NameSupportedDefined By
BasicAuthOAS2,OAS3
ApiKeyOAS2,OAS3
OpenIDConnectOAS3
BearerTokenOAS3
OAuth2_ImplicitOAS2,OAS3
OAuth2_PasswordOAS2,OAS3
OAuth2_ClientCredentialsOAS2,OAS3
OAuth2_AuthorizationCodeOAS2,OAS3

Wire Format Feature

NameSupportedDefined By
JSONOAS2,OAS3
XMLOAS2,OAS3
PROTOBUFToolingExtension
CustomOAS2,OAS3
Last updated on by Miroslav Šedivý