Skip to content

Commit efa6fea

Browse files
committed
Sort out more of the docs.
1 parent c36572b commit efa6fea

2 files changed

Lines changed: 18 additions & 8 deletions

File tree

Database/src/main/java/org/broken/arrow/library/database/construct/query/builder/TableColumnCache.java

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package org.broken.arrow.library.database.construct.query.builder;
22

33

4+
import org.broken.arrow.library.database.construct.query.builder.tablebuilder.SQLConstraints;
45
import org.broken.arrow.library.database.construct.query.builder.tablebuilder.TableColumn;
56
import org.broken.arrow.library.database.construct.query.columnbuilder.Column;
67
import org.broken.arrow.library.database.construct.query.columnbuilder.ColumnBuilder;
@@ -37,11 +38,15 @@ public String build() {
3738
}
3839

3940
/**
40-
* Builds a comma-separated string representation of all added columns
41-
* by invoking their {@code toString()} methods.
42-
* Returns an empty string if no columns have been added.
41+
* Builds the SQL fragment representing this column's definition,
42+
* excluding any {@link SQLConstraints#primaryKey() primary key} constraints.
43+
* <p>
44+
* This method is intended for generating column definitions in contexts
45+
* where primary keys are defined separately (e.g. composite keys or
46+
* table-level constraints).
4347
*
44-
* @return a comma-separated string of columns.
48+
* @return the SQL string fragment for the column definition without
49+
* primary key constraints
4550
*/
4651
@Override
4752
public String buildCampsiteKey() {

Database/src/main/java/org/broken/arrow/library/database/construct/query/columnbuilder/ColumnBuilder.java

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package org.broken.arrow.library.database.construct.query.columnbuilder;
22

3+
import org.broken.arrow.library.database.construct.query.builder.tablebuilder.SQLConstraints;
34
import org.broken.arrow.library.database.construct.query.builder.tablebuilder.TableColumn;
45

56
import java.util.ArrayList;
@@ -114,11 +115,15 @@ public String build() {
114115
}
115116

116117
/**
117-
* Builds a comma-separated string representation of all added columns
118-
* by invoking their {@code toString()} methods.
119-
* Returns an empty string if no columns have been added.
118+
* Builds the SQL fragment representing this column's definition,
119+
* excluding for example {@link SQLConstraints#primaryKey() primary key} constraints.
120+
* <p>
121+
* This method is intended for generating column definitions in contexts
122+
* where like primary keys are defined separately (e.g. composite keys or
123+
* table-level constraints).
120124
*
121-
* @return a comma-separated string of columns.
125+
* @return the SQL string fragment for the column definition without
126+
* some constraints.
122127
*/
123128
public String buildCampsiteKey(){
124129
return "";

0 commit comments

Comments
 (0)