ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-04-18 16:18:12 +00:00
Code Issues Actions2 Packages Projects Releases Wiki Activity

Restore separate enterprise implementation of cash selection for SQL server ()

Browse Source 
Create Enterprise version of CashSelectionSQLServerImpl and copy the content of CashSelectionSQLServerImpl as of 0c8c914 commit (with relevancy_status added and no copyrights).
The commit a28767343222ab5b7afdb1b546f6204fcaa69103 (OS--> ENT merge) replaced the original enterprise code an community independent version (they had filename in common only). To avoid this clash the original enterprise implementation will be now in EnterpriseCashSelectionSQLServerImpl (and is the default one for ServiceLoader) and  CashSelectionSQLServerImpl remains an empty placeholder in Enterprise.
This commit is contained in:
szymonsztuka 2018-10-11 15:04:48 +01:00 committed by GitHub
parent 78907bd6dc
commit 89886ce194
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 89 additions and 124 deletions
finance/src/main
kotlin/net/corda/finance/contracts/asset/cash/selection
CashSelectionSQLServerImpl.ktEnterpriseCashSelectionSQLServerImpl.kt
resources/META-INF/services
net.corda.finance.contracts.asset.cash.selection.AbstractCashSelection

125
finance/src/main/kotlin/net/corda/finance/contracts/asset/cash/selection/CashSelectionSQLServerImpl.kt

@ -1,123 +1,2 @@
package net.corda.finance.contracts.asset.cash.selection
import net.corda.core.contracts.Amount
import net.corda.core.crypto.toStringShort
import net.corda.core.identity.AbstractParty
import net.corda.core.identity.Party
import net.corda.core.utilities.OpaqueBytes
import net.corda.core.utilities.contextLogger
import net.corda.core.utilities.debug
import java.sql.Connection
import java.sql.DatabaseMetaData
import java.sql.ResultSet
import java.util.*
/**
* SQL Server / SQL Azure
*/
class CashSelectionSQLServerImpl : AbstractCashSelection(maxRetries = 16, retrySleep = 1000, retryCap = 5000) {
companion object {
const val JDBC_DRIVER_NAME = "Microsoft JDBC Driver"
private val log = contextLogger()
}
override fun isCompatible(metadata: DatabaseMetaData): Boolean {
return metadata.driverName.startsWith(JDBC_DRIVER_NAME, ignoreCase = true)
}
override fun toString() = "${this::class.qualifiedName} for '$JDBC_DRIVER_NAME'"
// This is one MSSQL implementation of the query to select just enough cash states to meet the desired amount.
// We select the cash states with smaller amounts first so that as the result, we minimize the numbers of
// unspent cash states remaining in the vault.
//
// If there is not enough cash, the query will return an empty resultset, which should signal to the caller
// of an exception, since the desired amount is assumed to always > 0.
// NOTE: The other two implementations, H2 and PostgresSQL, behave differently in this case - they return
// all in the vault instead of nothing. That seems to give the caller an extra burden to verify total returned
// >= amount.
// In addition, extra data fetched results in unnecessary I/O.
// Nevertheless, if so desired, we can achieve the same by changing the last FROM clause to
// FROM CTE LEFT JOIN Boundary AS B ON 1 = 1
// WHERE B.seqNo IS NULL OR CTE.seqNo <= B.seqNo
//
// Common Table Expression and Windowed functions help make the query more readable.
// Query plan does index scan on pennies_idx, which may be unavoidable due to the nature of the query.
override fun executeQuery(connection: Connection, amount: Amount<Currency>, lockId: UUID, notary: Party?,
onlyFromIssuerParties: Set<AbstractParty>,
withIssuerRefs: Set<OpaqueBytes>, withResultSet: (ResultSet) -> Boolean): Boolean {
val sb = StringBuilder()
// state_status = 0 -> UNCONSUMED.
// is_relevant = 0 -> RELEVANT.
sb.append( """
;WITH CTE AS
(
SELECT
vs.transaction_id,
vs.output_index,
ccs.pennies,
vs.lock_id,
total_pennies = SUM(ccs.pennies) OVER (ORDER BY ccs.pennies),
seqNo = ROW_NUMBER() OVER (ORDER BY ccs.pennies)
FROM vault_states AS vs INNER JOIN contract_cash_states AS ccs
ON vs.transaction_id = ccs.transaction_id AND vs.output_index = ccs.output_index
WHERE
vs.state_status = 0
AND vs.relevancy_status = 0
AND ccs.ccy_code = ?
AND (vs.lock_id = ? OR vs.lock_id IS NULL)
"""
)
if (notary != null)
sb.append("""
AND vs.notary_name = ?
""")
if (onlyFromIssuerParties.isNotEmpty()) {
val repeats = generateSequence { "?" }.take(onlyFromIssuerParties.size).joinToString(",")
sb.append("""
AND ccs.issuer_key_hash IN ($repeats)
""")
}
if (withIssuerRefs.isNotEmpty()) {
val repeats = generateSequence { "?" }.take(withIssuerRefs.size).joinToString(",")
sb.append("""
AND ccs.issuer_ref IN ($repeats)
""")
}
sb.append(
"""
),
Boundary AS
(
SELECT TOP (1) * FROM CTE WHERE total_pennies >= ? ORDER BY seqNo
)
SELECT CTE.transaction_id, CTE.output_index, CTE.pennies, CTE.total_pennies, CTE.lock_id
FROM CTE INNER JOIN Boundary AS B ON CTE.seqNo <= B.seqNo
;
"""
)
val selectJoin = sb.toString()
log.debug { selectJoin }
// Use prepared statement for protection against SQL Injection
connection.prepareStatement(selectJoin).use { statement ->
var pIndex = 0
statement.setString(++pIndex, amount.token.currencyCode)
statement.setString(++pIndex, lockId.toString())
if (notary != null)
statement.setString(++pIndex, notary.name.toString())
onlyFromIssuerParties.map { it.owningKey.toStringShort() }.forEach {
statement.setObject(++pIndex, it)
}
withIssuerRefs.map { it.bytes }.forEach {
statement.setBytes(++pIndex, it)
}
statement.setLong(++pIndex, amount.quantity)
log.debug(selectJoin)
statement.executeQuery().use { rs ->
return withResultSet(rs)
}
}
}
}
// Do not copy from OS.
// Enterprise version of cash selection for SQL Server/Azure is in EnterpriseCashSelectionSQLServerImpl.kt file.

86
finance/src/main/kotlin/net/corda/finance/contracts/asset/cash/selection/EnterpriseCashSelectionSQLServerImpl.kt Normal file

@ -0,0 +1,86 @@
package net.corda.finance.contracts.asset.cash.selection
import net.corda.core.contracts.Amount
import net.corda.core.crypto.toStringShort
import net.corda.core.identity.AbstractParty
import net.corda.core.identity.Party
import net.corda.core.utilities.OpaqueBytes
import net.corda.core.utilities.contextLogger
import java.sql.Connection
import java.sql.DatabaseMetaData
import java.sql.ResultSet
import java.util.*
/**
* SQL Server / SQL Azure
*/
class EnterpriseCashSelectionSQLServerImpl : AbstractCashSelection(maxRetries = 16, retrySleep = 1000, retryCap = 5000) {
companion object {
const val JDBC_DRIVER_NAME = "Microsoft JDBC Driver"
private val log = contextLogger()
}
override fun isCompatible(metadata: DatabaseMetaData): Boolean {
return metadata.driverName.startsWith(JDBC_DRIVER_NAME, ignoreCase = true)
}
override fun toString() = "${this::class.qualifiedName} for '$JDBC_DRIVER_NAME'"
override fun executeQuery(connection: Connection, amount: Amount<Currency>, lockId: UUID, notary: Party?,
onlyFromIssuerParties: Set<AbstractParty>,
withIssuerRefs: Set<OpaqueBytes>, withResultSet: (ResultSet) -> Boolean): Boolean {
val selectJoin = """
WITH row(transaction_id, output_index, pennies, total, lock_id) AS
(
SELECT vs.transaction_id, vs.output_index, ccs.pennies,
SUM(ccs.pennies) OVER (ORDER BY ccs.transaction_id, ccs.output_index RANGE UNBOUNDED PRECEDING), vs.lock_id
FROM contract_cash_states AS ccs, vault_states AS vs
WHERE vs.transaction_id = ccs.transaction_id AND vs.output_index = ccs.output_index
AND vs.state_status = 0
AND vs.relevancy_status = 0
AND ccs.ccy_code = ?
AND (vs.lock_id = ? OR vs.lock_id is null)"""+
(if (notary != null)
" AND vs.notary_name = ?" else "") +
// mssql-server driver does not implement setArray(), so in the following way
// we explicitly unpack the parameters list
(if (onlyFromIssuerParties.isNotEmpty()) {
val repeats = generateSequence { "?" }
.take(onlyFromIssuerParties.size)
.joinToString (",")
" AND ccs.issuer_key_hash IN ($repeats)"
} else { "" }) +
(if (withIssuerRefs.isNotEmpty()) {
val repeats = generateSequence { "?" }
.take(withIssuerRefs.size)
.joinToString (",")
" AND ccs.issuer_ref IN ($repeats)"
} else { "" }) +
""")
SELECT row.transaction_id, row.output_index, row.pennies, row.total, row.lock_id
FROM row where row.total < ? + row.pennies"""
// Use prepared statement for protection against SQL Injection
connection.prepareStatement(selectJoin).use { statement ->
var pIndex = 0
statement.setString(++pIndex, amount.token.currencyCode)
statement.setString(++pIndex, lockId.toString())
if (notary != null)
statement.setString(++pIndex, notary.name.toString())
onlyFromIssuerParties.map { it.owningKey.toStringShort() }.forEach {
statement.setObject(++pIndex, it)
}
withIssuerRefs.map { it.bytes }.forEach {
statement.setBytes(++pIndex, it)
}
statement.setLong(++pIndex, amount.quantity)
log.debug(selectJoin)
statement.executeQuery().use { rs ->
return withResultSet(rs)
}
}
}
}

2
finance/src/main/resources/META-INF/services/net.corda.finance.contracts.asset.cash.selection.AbstractCashSelection

@ -1,4 +1,4 @@
net.corda.finance.contracts.asset.cash.selection.CashSelectionH2Impl
net.corda.finance.contracts.asset.cash.selection.CashSelectionPostgreSQLImpl
net.corda.finance.contracts.asset.cash.selection.CashSelectionSQLServerImpl
net.corda.finance.contracts.asset.cash.selection.EnterpriseCashSelectionSQLServerImpl
net.corda.finance.contracts.asset.cash.selection.CashSelectionOracleImpl