Skip to content

Commit

Permalink
feat: Add ability to use custom sequence in auto-increment column
Browse files Browse the repository at this point in the history
  • Loading branch information
@joc-a
joc-a committed Aug 13, 2024
1 parent e63f35b commit 4d04247
Show file tree
Hide file tree
Showing 7 changed files with 142 additions and 68 deletions.
4 changes: 4 additions & 0 deletions exposed-core/api/exposed-core.api
View file
Original file line number Diff line number Diff line change
Expand Up @@ -221,11 +221,13 @@ public final class org/jetbrains/exposed/sql/ArrayColumnType : org/jetbrains/exp

public final class org/jetbrains/exposed/sql/AutoIncColumnType : org/jetbrains/exposed/sql/IColumnType {
public fun <init> (Lorg/jetbrains/exposed/sql/ColumnType;Ljava/lang/String;Ljava/lang/String;)V
public fun <init> (Lorg/jetbrains/exposed/sql/ColumnType;Lorg/jetbrains/exposed/sql/Sequence;)V
public fun equals (Ljava/lang/Object;)Z
public final fun getAutoincSeq ()Ljava/lang/String;
public final fun getDelegate ()Lorg/jetbrains/exposed/sql/ColumnType;
public final fun getNextValExpression ()Lorg/jetbrains/exposed/sql/NextVal;
public fun getNullable ()Z
public final fun getSequence ()Lorg/jetbrains/exposed/sql/Sequence;
public fun hashCode ()I
public fun nonNullValueAsDefaultString (Ljava/lang/Object;)Ljava/lang/String;
public fun nonNullValueToString (Ljava/lang/Object;)Ljava/lang/String;
Expand Down Expand Up @@ -2132,6 +2134,7 @@ public final class org/jetbrains/exposed/sql/Sequence {
public final fun getIncrementBy ()Ljava/lang/Long;
public final fun getMaxValue ()Ljava/lang/Long;
public final fun getMinValue ()Ljava/lang/Long;
public final fun getName ()Ljava/lang/String;
public final fun getStartWith ()Ljava/lang/Long;
}

Expand Down Expand Up @@ -2424,6 +2427,7 @@ public class org/jetbrains/exposed/sql/Table : org/jetbrains/exposed/sql/ColumnS
public static synthetic fun array$default (Lorg/jetbrains/exposed/sql/Table;Ljava/lang/String;Lorg/jetbrains/exposed/sql/ColumnType;Ljava/lang/Integer;ILjava/lang/Object;)Lorg/jetbrains/exposed/sql/Column;
public final fun autoGenerate (Lorg/jetbrains/exposed/sql/Column;)Lorg/jetbrains/exposed/sql/Column;
public final fun autoIncrement (Lorg/jetbrains/exposed/sql/Column;Ljava/lang/String;)Lorg/jetbrains/exposed/sql/Column;
public final fun autoIncrement (Lorg/jetbrains/exposed/sql/Column;Lorg/jetbrains/exposed/sql/Sequence;)Lorg/jetbrains/exposed/sql/Column;
public static synthetic fun autoIncrement$default (Lorg/jetbrains/exposed/sql/Table;Lorg/jetbrains/exposed/sql/Column;Ljava/lang/String;ILjava/lang/Object;)Lorg/jetbrains/exposed/sql/Column;
public final fun autoinc (Lorg/jetbrains/exposed/sql/Column;Ljava/lang/String;)Lorg/jetbrains/exposed/sql/Column;
public static synthetic fun autoinc$default (Lorg/jetbrains/exposed/sql/Table;Lorg/jetbrains/exposed/sql/Column;Ljava/lang/String;ILjava/lang/Object;)Lorg/jetbrains/exposed/sql/Column;
Expand Down
23 changes: 19 additions & 4 deletions exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/ColumnType.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,20 @@ class AutoIncColumnType<T>(
private val fallbackSeqName: String
) : IColumnType<T> by delegate {

private val nextValValue = run {
val sequence = Sequence(_autoincSeq ?: fallbackSeqName)
if (delegate is IntegerColumnType) sequence.nextIntVal() else sequence.nextLongVal()
private var _sequence: Sequence? = null

val sequence: Sequence?
get() = _sequence ?: autoincSeq?.let {
Sequence(
it,
startWith = 1,
minValue = 1,
maxValue = Long.MAX_VALUE
)
}

constructor(delegate: ColumnType<T>, sequence: Sequence) : this(delegate, sequence.name, sequence.name) {
_sequence = sequence
}

/** The name of the sequence used to generate new values for this auto-increment column. */
Expand All @@ -148,7 +159,9 @@ class AutoIncColumnType<T>(

/** The SQL expression that advances the sequence of this auto-increment column. */
val nextValExpression: NextVal<*>?
get() = nextValValue.takeIf { autoincSeq != null }
get() = autoincSeq?.let {
if (delegate is IntegerColumnType) sequence?.nextIntVal() else sequence?.nextLongVal()
}

private fun resolveAutoIncType(columnType: IColumnType<*>): String = when {
columnType is EntityIDColumnType<*> -> resolveAutoIncType(columnType.idColumn.columnType)
Expand Down Expand Up @@ -178,6 +191,7 @@ class AutoIncColumnType<T>(
delegate != other.delegate -> false
_autoincSeq != other._autoincSeq -> false
fallbackSeqName != other.fallbackSeqName -> false
sequence != other.sequence -> false
else -> true
}
}
Expand All @@ -186,6 +200,7 @@ class AutoIncColumnType<T>(
var result = delegate.hashCode()
result = 31 * result + (_autoincSeq?.hashCode() ?: 0)
result = 31 * result + fallbackSeqName.hashCode()
result = 31 * result + (sequence?.hashCode() ?: 0)
return result
}
}
Expand Down
6 changes: 3 additions & 3 deletions exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/SchemaUtils.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,12 +109,12 @@ object SchemaUtils {
}

private fun tableDdlWithoutExistingSequence(table: Table): List<String> {
val existingAutoIncSeq = table.autoIncColumn?.autoIncColumnType?.autoincSeq
?.takeIf { currentDialect.sequenceExists(Sequence(it)) }
val existingAutoIncSeq = table.autoIncColumn?.autoIncColumnType?.sequence
?.takeIf { currentDialect.sequenceExists(it) }

return table.ddl.filter { statement ->
if (existingAutoIncSeq != null) {
!statement.lowercase().startsWith("create sequence") || !statement.contains(existingAutoIncSeq)
!statement.lowercase().startsWith("create sequence") || !statement.contains(existingAutoIncSeq.name)
} else {
true
}
Expand Down
2 changes: 1 addition & 1 deletion exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/Sequence.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import org.jetbrains.exposed.sql.vendors.currentDialect
* @param cache Specifies how many sequence numbers are to be pre-allocated and stored in memory for faster access.
*/
class Sequence(
private val name: String,
val name: String,
val startWith: Long? = null,
val incrementBy: Long? = null,
val minValue: Long? = null,
Expand Down
30 changes: 19 additions & 11 deletions exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/Table.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -920,6 +920,17 @@ open class Table(name: String = "") : ColumnSet(), DdlAware {
fun <N : Any> Column<N>.autoIncrement(idSeqName: String? = null): Column<N> =
cloneWithAutoInc(idSeqName).also { replaceColumn(this, it) }

/**
* Make @receiver column an auto-increment column to generate its values in a database.
* **Note:** Only integer and long columns are supported (signed and unsigned types).
* Some databases, like PostgreSQL, support auto-increment via sequences.
* In this case, a sequence should be provided using the [sequence] param.
*
* @param sequence a parameter to provide a sequence
*/
fun <N : Any> Column<N>.autoIncrement(sequence: Sequence): Column<N> =
cloneWithAutoInc(sequence).also { replaceColumn(this, it) }

/**
* Make @receiver column an auto-increment column to generate its values in a database.
* **Note:** Only integer and long columns are supported (signed and unsigned types).
Expand Down Expand Up @@ -1571,6 +1582,12 @@ open class Table(name: String = "") : ColumnSet(), DdlAware {
else -> error("Unsupported column type for auto-increment $columnType")
}

private fun <T> Column<T>.cloneWithAutoInc(sequence: Sequence): Column<T> = when (columnType) {
is AutoIncColumnType -> this
is ColumnType -> this.withColumnType(AutoIncColumnType(columnType, sequence))
else -> error("Unsupported column type for auto-increment $columnType")
}

// DDL statements

internal fun primaryKeyConstraint(): String? {
Expand Down Expand Up @@ -1636,16 +1653,7 @@ open class Table(name: String = "") : ColumnSet(), DdlAware {
}

private fun createAutoIncColumnSequence(): List<String> {
return autoIncColumn?.autoIncColumnType?.autoincSeq?.let {
Sequence(
it,
startWith = 1,
minValue = 1,
maxValue = Long.MAX_VALUE
)
}
?.createStatement()
.orEmpty()
return autoIncColumn?.autoIncColumnType?.sequence?.createStatement().orEmpty()
}

override fun modifyStatement(): List<String> =
Expand All @@ -1665,7 +1673,7 @@ open class Table(name: String = "") : ColumnSet(), DdlAware {
}
}

val dropSequence = autoIncColumn?.autoIncColumnType?.autoincSeq?.let { Sequence(it).dropStatement() }.orEmpty()
val dropSequence = autoIncColumn?.autoIncColumnType?.sequence?.dropStatement().orEmpty()

return listOf(dropTable) + dropSequence
}
Expand Down
54 changes: 6 additions & 48 deletions exposed-tests/src/test/kotlin/org/jetbrains/exposed/sql/tests/shared/ddl/CreateTableTests.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -308,14 +308,7 @@ class CreateTableTests : DatabaseTestsBase() {
withDb {
val t = TransactionManager.current()
val expected = listOfNotNull(
child.autoIncColumn?.autoIncColumnType?.autoincSeq?.let {
Sequence(
it,
startWith = 1,
minValue = 1,
maxValue = Long.MAX_VALUE
).createStatement().single()
},
child.autoIncColumn?.autoIncColumnType?.sequence?.createStatement()?.single(),
"CREATE TABLE " + addIfNotExistsIfSupported() + "${t.identity(child)} (" +
"${child.columns.joinToString { it.descriptionDdl(false) }}," +
" CONSTRAINT ${t.db.identifierManager.cutIfNecessaryAndQuote(fkName).inProperCase()}" +
Expand Down Expand Up @@ -389,14 +382,7 @@ class CreateTableTests : DatabaseTestsBase() {
withDb {
val t = TransactionManager.current()
val expected = listOfNotNull(
child.autoIncColumn?.autoIncColumnType?.autoincSeq?.let {
Sequence(
it,
startWith = 1,
minValue = 1,
maxValue = Long.MAX_VALUE
).createStatement().single()
},
child.autoIncColumn?.autoIncColumnType?.sequence?.createStatement()?.single(),
"CREATE TABLE " + addIfNotExistsIfSupported() + "${t.identity(child)} (" +
"${child.columns.joinToString { it.descriptionDdl(false) }}," +
" CONSTRAINT ${t.db.identifierManager.cutIfNecessaryAndQuote(fkName).inProperCase()}" +
Expand Down Expand Up @@ -424,14 +410,7 @@ class CreateTableTests : DatabaseTestsBase() {
withDb {
val t = TransactionManager.current()
val expected = listOfNotNull(
child.autoIncColumn?.autoIncColumnType?.autoincSeq?.let {
Sequence(
it,
startWith = 1,
minValue = 1,
maxValue = Long.MAX_VALUE
).createStatement().single()
},
child.autoIncColumn?.autoIncColumnType?.sequence?.createStatement()?.single(),
"CREATE TABLE " + addIfNotExistsIfSupported() + "${t.identity(child)} (" +
"${child.columns.joinToString { it.descriptionDdl(false) }}," +
" CONSTRAINT ${t.db.identifierManager.cutIfNecessaryAndQuote(fkName).inProperCase()}" +
Expand Down Expand Up @@ -462,14 +441,7 @@ class CreateTableTests : DatabaseTestsBase() {
withDb {
val t = TransactionManager.current()
val expected = listOfNotNull(
child.autoIncColumn?.autoIncColumnType?.autoincSeq?.let {
Sequence(
it,
startWith = 1,
minValue = 1,
maxValue = Long.MAX_VALUE
).createStatement().single()
},
child.autoIncColumn?.autoIncColumnType?.sequence?.createStatement()?.single(),
"CREATE TABLE " + addIfNotExistsIfSupported() + "${t.identity(child)} (" +
"${child.columns.joinToString { it.descriptionDdl(false) }}," +
" CONSTRAINT ${t.db.identifierManager.cutIfNecessaryAndQuote(fkName).inProperCase()}" +
Expand Down Expand Up @@ -507,14 +479,7 @@ class CreateTableTests : DatabaseTestsBase() {
val t = TransactionManager.current()
val updateCascadePart = if (testDb != TestDB.ORACLE) " ON UPDATE CASCADE" else ""
val expected = listOfNotNull(
child.autoIncColumn?.autoIncColumnType?.autoincSeq?.let {
Sequence(
it,
startWith = 1,
minValue = 1,
maxValue = Long.MAX_VALUE
).createStatement().single()
},
child.autoIncColumn?.autoIncColumnType?.sequence?.createStatement()?.single(),
"CREATE TABLE " + addIfNotExistsIfSupported() + "${t.identity(child)} (" +
"${child.columns.joinToString { it.descriptionDdl(false) }}," +
" CONSTRAINT ${t.db.identifierManager.cutIfNecessaryAndQuote(fkName).inProperCase()}" +
Expand Down Expand Up @@ -553,14 +518,7 @@ class CreateTableTests : DatabaseTestsBase() {
withDb {
val t = TransactionManager.current()
val expected = listOfNotNull(
child.autoIncColumn?.autoIncColumnType?.autoincSeq?.let {
Sequence(
it,
startWith = 1,
minValue = 1,
maxValue = Long.MAX_VALUE
).createStatement().single()
},
child.autoIncColumn?.autoIncColumnType?.sequence?.createStatement()?.single(),
"CREATE TABLE " + addIfNotExistsIfSupported() + "${t.identity(child)} (" +
"${child.columns.joinToString { it.descriptionDdl(false) }}," +
" CONSTRAINT ${t.db.identifierManager.cutIfNecessaryAndQuote(fkName).inProperCase()}" +
Expand Down
91 changes: 90 additions & 1 deletion exposed-tests/src/test/kotlin/org/jetbrains/exposed/sql/tests/shared/ddl/SequencesTests.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import org.jetbrains.exposed.sql.tests.TestDB
import org.jetbrains.exposed.sql.tests.currentDialectTest
import org.jetbrains.exposed.sql.tests.inProperCase
import org.jetbrains.exposed.sql.tests.shared.assertEquals
import org.jetbrains.exposed.sql.tests.shared.assertFalse
import org.jetbrains.exposed.sql.tests.shared.assertTrue
import org.jetbrains.exposed.sql.vendors.currentDialect
import org.junit.Test
Expand Down Expand Up @@ -61,6 +62,39 @@ class SequencesTests : DatabaseTestsBase() {
}
}

@Test
fun `testInsertWithCustomSequence`() {
val tester = object : Table("tester") {
val id = integer("id").autoIncrement(myseq)
var name = varchar("name", 25)

override val primaryKey = PrimaryKey(id, name)
}
withDb {
if (currentDialectTest.supportsSequenceAsGeneratedKeys) {
try {
SchemaUtils.create(tester)
assertTrue(myseq.exists())

var testerId = tester.insert {
it[name] = "Hichem"
} get tester.id

assertEquals(myseq.startWith, testerId.toLong())

testerId = tester.insert {
it[name] = "Andrey"
} get tester.id

assertEquals(myseq.startWith!! + myseq.incrementBy!!, testerId.toLong())
} finally {
SchemaUtils.drop(tester)
assertFalse(myseq.exists())
}
}
}
}

@Test
fun `test insert int IdTable with sequences`() {
withTables(DeveloperWithLongId) {
Expand Down Expand Up @@ -88,7 +122,40 @@ class SequencesTests : DatabaseTestsBase() {
}

@Test
fun `test insert LongIdTable with auth-increment with sequence`() {
fun `testInsertInIdTableWithCustomSequence`() {
val tester = object : IdTable<Long>("tester") {
override val id = long("id").autoIncrement(myseq).entityId()
var name = varchar("name", 25)

override val primaryKey = PrimaryKey(id, name)
}
withDb {
if (currentDialectTest.supportsSequenceAsGeneratedKeys) {
try {
SchemaUtils.create(tester)
assertTrue(myseq.exists())

var testerId = tester.insert {
it[name] = "Hichem"
} get tester.id

assertEquals(myseq.startWith, testerId.value)

testerId = tester.insert {
it[name] = "Andrey"
} get tester.id

assertEquals(myseq.startWith!! + myseq.incrementBy!!, testerId.value)
} finally {
SchemaUtils.drop(tester)
assertFalse(myseq.exists())
}
}
}
}

@Test
fun `test insert LongIdTable with auto-increment with sequence`() {
withDb {
if (currentDialectTest.supportsSequenceAsGeneratedKeys) {
try {
Expand Down Expand Up @@ -152,6 +219,28 @@ class SequencesTests : DatabaseTestsBase() {
}
}

@Test
fun testExistingSequencesForAutoIncrementWithCustomSequence() {
val tableWithExplicitSequenceName = object : IdTable<Long>() {
override val id: Column<EntityID<Long>> = long("id").autoIncrement(myseq).entityId()
}

withDb {
if (currentDialectTest.supportsSequenceAsGeneratedKeys) {
try {
SchemaUtils.create(tableWithExplicitSequenceName)

val sequences = currentDialectTest.sequences()

assertTrue(sequences.isNotEmpty())
assertTrue(sequences.any { it == myseq.name.inProperCase() })
} finally {
SchemaUtils.drop(tableWithExplicitSequenceName)
}
}
}
}

@Test
fun testExistingSequencesForAutoIncrementWithExplicitSequenceName() {
val sequenceName = "id_seq"
Expand Down

0 comments on commit 4d04247

Please sign in to comment.