top / index / prev / next / target / source

2021-04-26 diary: [Oiyokan] oiyokan-settings.json spec

いがぴょんの日記 日記形式でつづる いがぴょんコラム ウェブページです。

[Oiyokan] oiyokan-settings.json spec

How to set oiyokan-settings.json

oiyokan-settings.json is an important settings file to control Oiyokan.

oiyokan-settings.json location

src/main/resources/iyokan/oiyokan-settings.json

Abstract of structure

File format

Section

oiyokan-settings.json has 3 main section: container section, database section, entitySet section.

container section

keydescription
namespaceName of namespace. ex: Oiyokan
containerNameName of container. ex: Container. Oiyokan support one container.

database section

keydescription
nameName of database setting. ex oiyoUnitTestDb
typeDatabase Type. one of: h2, PostgreSQL, MySQL, SQLSV2008, ORCL18
descriptionDescription of this database setting.
jdbcDriverClassname of JDBC driver. ex: org.h2.Driver
jdbcUrlJDBC url to connect. ex: jdbc:h2:mem:mydb;DB_CLOSE_DELAY=-1;
jdbcUserJDBC user name. ex: user1
jdbcPassEncJDBC password with Encryption. (Recommended)
jdbcPassPlainJDBC password without Encryption. (jdbcPassEnc is recommended)

entitySet section

keydescription
nameName of EntitySet.
descriptionDescription of this EntitySet.
dbSettingNameName of database setting.
canCreateCRUD authz of Create. Default:true.
canReadCRUD authz of Read. true supported only. Default:true.
canUpdateCRUD authz of Update. Default:true.
canDeleteCRUD authz of Delete. Default:true.
omitCountAllIgnore $count in the case of NO conditional query. Default:false.
jdbcStmtTimeoutTimeout seconds. Default:'30'
entityTypeList of entityType.

entityType - sub section

keydescription
nameName of EntityType
dbNameTable name on Database
keyNameArray of key property name. Entity should have key.
propertyArray of property.

property - sub sub section

keydescription
nameName of property
dbNameColumn name on Database. ex: Types.VARCHAR
edmTypeColumn name on Database. ex: Edm.String
dbTypeType name on Database. ex: VARCHAR
jdbcSetMethod(reserved) Hint method name of JDBC API. ex: setString
autoGenKeySet true if this property is auto generated key. Default:false
nullabletrue:Nullable, false:NOT NULL, null:Unknown. Default:true.
maxLengthLength of string field.
lengthFixedSet field fixed. For CHAR type. Default:false.
precisionprecision of decimal. Default:null.
scalescale of decimal. Default:null.
dbDefaultDefault value of database. Default:null.
filterTreatNullAsBlankTreat property (String) value null as blank. Default:false.

関連する日記

Last modified: $Date: 2021-05-13 $

登場キーワード


この日記について