Skip to content
This repository was archived by the owner on Oct 24, 2020. It is now read-only.

Commit c583993

Browse files
nakamura-tonakamura-to
committed
Add configuration documents
1 parent 0788344 commit c583993

File tree

5 files changed

+194
-18
lines changed

5 files changed

+194
-18
lines changed

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ The above properties are all optional.
4343
Our extension infers the `quarkus.doma.datasource-name` and `quarkus.doma.dialect` properties
4444
from the `quarkus.datasource` properties.
4545

46+
See [quarkus-doma.adoc](./quarkus-doma.adoc) for more details.
47+
4648
### Support for native images
4749

4850
Our extension recognizes reflective classes and resources,
@@ -54,7 +56,7 @@ and includes them into your native image without additional configurations.
5456

5557
```groovy
5658
dependencies {
57-
implementation "org.seasar.doma:doma-quarkus:1.0.0"
59+
implementation "org.seasar.doma:doma-quarkus:0.2.0-SNAPSHOT"
5860
implementation "org.seasar.doma:doma-core:2.37.0"
5961
annotationProcessor "org.seasar.doma:doma-processor:2.37.0"
6062
}

‎pom.xml‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
<google-java-format.version>1.7</google-java-format.version>
4343
<compiler-plugin.version>3.8.1</compiler-plugin.version>
4444
<source-plugin.version>2.2.1</source-plugin.version>
45-
<javadoc-plugin.version>2.9.1</javadoc-plugin.version>
45+
<javadoc-plugin.version>3.2.0</javadoc-plugin.version>
4646
<gpg-plugin.version>1.5</gpg-plugin.version>
4747
<versions-plugin.version>2.7</versions-plugin.version>
4848
<nexus-staging-plugin.version>1.6.7</nexus-staging-plugin.version>
@@ -86,6 +86,16 @@
8686
<groupId>org.apache.maven.plugins</groupId>
8787
<artifactId>maven-javadoc-plugin</artifactId>
8888
<version>${javadoc-plugin.version}</version>
89+
<configuration>
90+
<quiet>true</quiet>
91+
<doclint>none</doclint>
92+
<show>package</show>
93+
<tags>
94+
<tag>
95+
<name>asciidoclet</name>
96+
</tag>
97+
</tags>
98+
</configuration>
8999
<executions>
90100
<execution>
91101
<id>attach-javadocs</id>

‎quarkus-doma.adoc‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
[.configuration-legend]
2+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
3+
[.configuration-reference.searchable, cols="80,.^10,.^10"]
4+
|===
5+
6+
h|[[quarkus-doma_configuration]]link:#quarkus-doma_configuration[Configuration property]
7+
8+
h|Type
9+
h|Default
10+
11+
a|icon:lock[title=Fixed at build time] [[quarkus-doma_quarkus.doma.dialect]]`link:#quarkus-doma_quarkus.doma.dialect[quarkus.doma.dialect]`
12+
13+
[.description]
14+
--
15+
The SQL dialect.
16+
--|`standard`, `sqlite`, `db2`, `mssql`, `mssql2008`, `mysql`, `postgres`, `oracle`, `h2`, `hsql`
17+
|
18+
19+
20+
a|icon:lock[title=Fixed at build time] [[quarkus-doma_quarkus.doma.sql-file-repository]]`link:#quarkus-doma_quarkus.doma.sql-file-repository[quarkus.doma.sql-file-repository]`
21+
22+
[.description]
23+
--
24+
The SQL file repository.
25+
--|`no-cache`, `greedy-cache`
26+
|`greedy-cache`
27+
28+
29+
a|icon:lock[title=Fixed at build time] [[quarkus-doma_quarkus.doma.naming]]`link:#quarkus-doma_quarkus.doma.naming[quarkus.doma.naming]`
30+
31+
[.description]
32+
--
33+
The naming convention controller.
34+
--|`none`, `lower-case`, `upper-case`, `snake-lower-case`, `snake-upper-case`, `lenient-snake-lower-case`, `lenient-snake-upper-case`, `default`
35+
|`default`
36+
37+
38+
a|icon:lock[title=Fixed at build time] [[quarkus-doma_quarkus.doma.exception-sql-log-type]]`link:#quarkus-doma_quarkus.doma.exception-sql-log-type[quarkus.doma.exception-sql-log-type]`
39+
40+
[.description]
41+
--
42+
The SQL log type that determines the SQL log format in exceptions.
43+
--|`raw`, `formatted`, `none`
44+
|`none`
45+
46+
47+
a|icon:lock[title=Fixed at build time] [[quarkus-doma_quarkus.doma.datasource-name]]`link:#quarkus-doma_quarkus.doma.datasource-name[quarkus.doma.datasource-name]`
48+
49+
[.description]
50+
--
51+
The name of the data source.
52+
--|string
53+
|
54+
55+
56+
a|icon:lock[title=Fixed at build time] [[quarkus-doma_quarkus.doma.batch-size]]`link:#quarkus-doma_quarkus.doma.batch-size[quarkus.doma.batch-size]`
57+
58+
[.description]
59+
--
60+
The batch size.
61+
--|int
62+
|`0`
63+
64+
65+
a|icon:lock[title=Fixed at build time] [[quarkus-doma_quarkus.doma.fetch-size]]`link:#quarkus-doma_quarkus.doma.fetch-size[quarkus.doma.fetch-size]`
66+
67+
[.description]
68+
--
69+
The fetch size.
70+
--|int
71+
|`0`
72+
73+
74+
a|icon:lock[title=Fixed at build time] [[quarkus-doma_quarkus.doma.max-rows]]`link:#quarkus-doma_quarkus.doma.max-rows[quarkus.doma.max-rows]`
75+
76+
[.description]
77+
--
78+
The max rows.
79+
--|int
80+
|`0`
81+
82+
83+
a|icon:lock[title=Fixed at build time] [[quarkus-doma_quarkus.doma.query-timeout]]`link:#quarkus-doma_quarkus.doma.query-timeout[quarkus.doma.query-timeout]`
84+
85+
[.description]
86+
--
87+
The query timeout limit in seconds.
88+
--|int
89+
|`0`
90+
91+
92+
a|icon:lock[title=Fixed at build time] [[quarkus-doma_quarkus.doma.log.level]]`link:#quarkus-doma_quarkus.doma.log.level[quarkus.doma.log.level]`
93+
94+
[.description]
95+
--
96+
The level of log.
97+
--|`fatal`, `error`, `warn`, `info`, `debug`, `trace`
98+
|`debug`
99+
100+
101+
a|icon:lock[title=Fixed at build time] [[quarkus-doma_quarkus.doma.log.sql]]`link:#quarkus-doma_quarkus.doma.log.sql[quarkus.doma.log.sql]`
102+
103+
[.description]
104+
--
105+
Shows SQL logs.
106+
--|boolean
107+
|`false`
108+
109+
110+
a|icon:lock[title=Fixed at build time] [[quarkus-doma_quarkus.doma.log.dao]]`link:#quarkus-doma_quarkus.doma.log.dao[quarkus.doma.log.dao]`
111+
112+
[.description]
113+
--
114+
Shows DAO logs.
115+
--|boolean
116+
|`false`
117+
118+
119+
a|icon:lock[title=Fixed at build time] [[quarkus-doma_quarkus.doma.log.closing-failure]]`link:#quarkus-doma_quarkus.doma.log.closing-failure[quarkus.doma.log.closing-failure]`
120+
121+
[.description]
122+
--
123+
Shows the logs of the failure to close JDBC resource.
124+
--|boolean
125+
|`false`
126+
127+
|===

‎runtime/src/main/java/org/seasar/doma/quarkus/runtime/DomaConfiguration.java‎

Lines changed: 49 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
package org.seasar.doma.quarkus.runtime;
22

3-
import io.quarkus.runtime.annotations.ConfigDocSection;
43
import io.quarkus.runtime.annotations.ConfigItem;
54
import io.quarkus.runtime.annotations.ConfigRoot;
65
import java.util.Optional;
76
import java.util.function.Supplier;
7+
import org.seasar.doma.jdbc.Config;
88
import org.seasar.doma.jdbc.GreedyCacheSqlFileRepository;
99
import org.seasar.doma.jdbc.Naming;
1010
import org.seasar.doma.jdbc.NoCacheSqlFileRepository;
@@ -25,42 +25,79 @@
2525
@ConfigRoot
2626
public class DomaConfiguration {
2727

28-
/** */
28+
/**
29+
* The SQL dialect.
30+
*
31+
* @see Config#getDialect()
32+
* @asciidoclet
33+
*/
2934
@ConfigItem public Optional<DialectType> dialect;
3035

31-
/** */
36+
/**
37+
* The SQL file repository.
38+
*
39+
* @see Config#getSqlFileRepository()
40+
*/
3241
@ConfigItem(defaultValue = "greedy-cache")
3342
public SqlFileRepositoryType sqlFileRepository;
3443

35-
/** */
44+
/**
45+
* The naming convention controller.
46+
*
47+
* @see Config#getNaming()
48+
*/
3649
@ConfigItem(defaultValue = "default")
3750
public NamingType naming;
3851

39-
/** */
52+
/**
53+
* The SQL log type that determines the SQL log format in exceptions.
54+
*
55+
* @see Config#getExceptionSqlLogType()
56+
*/
4057
@ConfigItem(defaultValue = "none")
4158
public SqlLogType exceptionSqlLogType;
4259

43-
/** */
60+
/**
61+
* The name of the data source.
62+
*
63+
* @see Config#getDataSourceName()
64+
*/
4465
@ConfigItem public Optional<String> datasourceName;
4566

46-
/** */
67+
/**
68+
* The batch size.
69+
*
70+
* @see Config#getBatchSize()
71+
*/
4772
@ConfigItem(defaultValue = "0")
4873
public int batchSize;
4974

50-
/** */
75+
/**
76+
* The fetch size.
77+
*
78+
* @see Config#getFetchSize()
79+
*/
5180
@ConfigItem(defaultValue = "0")
5281
public int fetchSize;
5382

54-
/** */
83+
/**
84+
* The max rows.
85+
*
86+
* @see Config#getMaxRows()
87+
*/
5588
@ConfigItem(defaultValue = "0")
5689
public int maxRows;
5790

58-
/** */
91+
/**
92+
* The query timeout limit in seconds.
93+
*
94+
* @see Config#getQueryTimeout()
95+
*/
5996
@ConfigItem(defaultValue = "0")
6097
public int queryTimeout;
6198

62-
/** */
63-
@ConfigItem @ConfigDocSection public LogConfiguration log;
99+
/** The log configuration. */
100+
@ConfigItem public LogConfiguration log;
64101

65102
@Override
66103
public String toString() {

‎runtime/src/main/java/org/seasar/doma/quarkus/runtime/LogConfiguration.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@
77
@ConfigGroup
88
public class LogConfiguration {
99

10-
/** */
10+
/** The level of log. */
1111
@ConfigItem(defaultValue = "DEBUG")
1212
public Logger.Level level = Logger.Level.DEBUG;
1313

14-
/** */
14+
/** Shows SQL logs. */
1515
@ConfigItem public boolean sql;
1616

17-
/** */
17+
/** Shows DAO logs. */
1818
@ConfigItem public boolean dao;
1919

20-
/** */
20+
/** Shows the logs of the failure to close JDBC resource. */
2121
@ConfigItem public boolean closingFailure;
2222

2323
@Override

0 commit comments

Comments
 (0)