Skip to content

Commit be59f8a

Browse files
committed
jdoc clarifications in DialectSpecificSettings
make things explicit that were implicit
1 parent ee53d89 commit be59f8a

File tree

1 file changed

+35
-6
lines changed

1 file changed

+35
-6
lines changed

hibernate-core/src/main/java/org/hibernate/cfg/DialectSpecificSettings.java

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,27 @@
1515
public interface DialectSpecificSettings {
1616
/**
1717
* Specifies whether this database is running on an Autonomous Database Cloud Service.
18+
* <p>
19+
* Ignored if Hibernate is able to determine this by querying the Oracle server at startup.
1820
*
1921
* @settingDefault {@code false}
2022
*/
2123
String ORACLE_AUTONOMOUS_DATABASE = "hibernate.dialect.oracle.is_autonomous";
2224

2325
/**
24-
* Specifies whether this database's {@code MAX_STRING_SIZE} is set to {@code EXTENDED}.
26+
* Specifies whether {@code MAX_STRING_SIZE} is set to {@code EXTENDED} on Oracle.
27+
* <p>
28+
* Ignored if Hibernate is able to determine the value of {@code MAX_STRING_SIZE} by
29+
* querying the Oracle server at startup.
2530
*
2631
* @settingDefault {@code false}
2732
*/
2833
String ORACLE_EXTENDED_STRING_SIZE = "hibernate.dialect.oracle.extended_string_size";
2934

3035
/**
3136
* Specifies whether this database is accessed using a database service protected by Application Continuity.
37+
* <p>
38+
* Ignored if Hibernate is able to determine this by querying the Oracle server at startup.
3239
*
3340
* @settingDefault {@code false}
3441
*
@@ -37,21 +44,27 @@ public interface DialectSpecificSettings {
3744
String ORACLE_APPLICATION_CONTINUITY = "hibernate.dialect.oracle.application_continuity";
3845

3946
/**
40-
* Specifies whether this database's {@code ansinull} setting is enabled.
4147
* Enables the use of the deprecated type {@code LONGVARBINARY} on Oracle instead of {@code BLOB}.
4248
*
4349
* @settingDefault {@code false}
4450
*/
4551
String ORACLE_PREFER_LONG_RAW = "hibernate.dialect.oracle.prefer_long_raw";
4652

4753
/**
54+
* Specifies whether the {@code ansinull} setting is enabled on Sybase.
55+
* <p>
56+
* Ignored if Hibernate is able to determine the value of {@code ansinull}
57+
* by querying the server {@code @@options} at startup.
4858
*
4959
* @settingDefault {@code false}
5060
*/
5161
String SYBASE_ANSI_NULL = "hibernate.dialect.sybase.extended_string_size";
5262

5363
/**
5464
* Specifies the maximum page size on Sybase.
65+
* <p>
66+
* Ignored if Hibernate is able to determine the page size by querying the
67+
* server {@code @@maxpagesize} at startup.
5568
*
5669
* @settingDefault {@value org.hibernate.dialect.SybaseASEDialect#MAX_PAGE_SIZE}
5770
*/
@@ -60,13 +73,19 @@ public interface DialectSpecificSettings {
6073
/**
6174
* Specifies the bytes per character to use based on the database's configured
6275
* <a href="https://dev.mysql.com/doc/refman/8.0/en/charset-charsets.html">charset</a>.
76+
* <p>
77+
* Ignored if Hibernate is able to determine the character set by querying the
78+
* server {@code @@character_set_database} at startup.
6379
*
6480
* @settingDefault {@code 4}
6581
*/
6682
String MYSQL_BYTES_PER_CHARACTER = "hibernate.dialect.mysql.bytes_per_character";
6783

6884
/**
6985
* Specifies whether the {@code NO_BACKSLASH_ESCAPES} sql mode is enabled.
86+
* <p>
87+
* Ignored if Hibernate is able to determine this by querying the server
88+
* {@code @@sql_mode} at startup.
7089
*
7190
* @settingDefault {@code false}
7291
*/
@@ -76,18 +95,28 @@ public interface DialectSpecificSettings {
7695
* Specifies a custom CockroachDB version string. The expected format of the string is
7796
* the one returned from the {@code version()} function, e.g.:
7897
* {@code "CockroachDB CCL v23.1.8 (x86_64-pc-linux-gnu, built 2023/08/04 18:11:44, go1.19.10)"}
98+
* <p>
99+
* Ignored if Hibernate is able to obtain the version string by querying the server at startup.
79100
*/
80101
String COCKROACH_VERSION_STRING = "hibernate.dialect.cockroach.version_string";
81102

82103
/**
83-
* Specifies the compatibility level of the SQL Server database as returned by {@code select compatibility_level from sys.databases}.
84-
* The number has three digits, the first two digits are the major version, the last digit is the minor version.
104+
* Specifies the compatibility level of the SQL Server database as returned by
105+
* {@code select compatibility_level from sys.databases}.
106+
* <p>
107+
* The number has three digits: the first two digits are the major version,
108+
* the last digit is the minor version.
109+
* <p>
110+
* Ignored if Hibernate is able to determine this by querying the {@code sys.databases}
111+
* table at startup.
85112
*/
86113
String SQL_SERVER_COMPATIBILITY_LEVEL = "hibernate.dialect.sqlserver.compatibility_level";
87114

88115
/**
89-
* Specifies the LOB prefetch size. LOBs larger than this value will be read into memory as the HANA JDBC driver closes
90-
* the LOB when the result set is closed.
116+
* Specifies the LOB prefetch size. LOBs larger than this value will be read into
117+
* memory as the HANA JDBC driver closes the LOB when the result set is closed.
118+
* <p>
119+
* Ignored if Hibernate is able to determine this by querying the server at startup.
91120
*
92121
* @settingDefault {@code 1024}
93122
*/

0 commit comments

Comments
 (0)