ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-20 21:43:14 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Minor docs update - Persistence API and node database (#4061)

Browse Source 
Note about database considerations regarding Cordapp compatibility between OS and ENT.
Remove database configuration "schema" as this is not implemented in OS, it was already mentioned as ignored for SQL server.
This commit is contained in:
szymonsztuka 2018-10-31 14:39:22 +00:00 committed by GitHub
parent 8ddd8d383d
commit 437a053037
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/source/api-persistence.rst
View File

@ -100,7 +100,7 @@ associate a ``StateRef`` with a persisted representation of a ``ContractState``
unconsumed states in the vault. unconsumed states in the vault.
The ``PersistentState`` subclass should be marked up as a JPA 2.1 *Entity* with a defined table name and having The ``PersistentState`` subclass should be marked up as a JPA 2.1 *Entity* with a defined table name and having
properties (in Kotlin, getters/setters in Java) annotated to map to the appropriate columns and SQL types. Additional properties (in Kotlin, getters/setters in Java) annotated to map to the appropriate columns and SQL types. Additional
entities can be included to model these properties where they are more complex, for example collections, so the mapping entities can be included to model these properties where they are more complex, for example collections, so the mapping
does not have to be *flat*. The ``MappedSchema`` must provide a list of all of the JPA entity classes for that schema does not have to be *flat*. The ``MappedSchema`` must provide a list of all of the JPA entity classes for that schema
in order to initialise the ORM layer. in order to initialise the ORM layer.
@ -111,6 +111,11 @@ Several examples of entities and mappings are provided in the codebase, includin
.. literalinclude:: ../../finance/src/main/kotlin/net/corda/finance/schemas/CashSchemaV1.kt .. literalinclude:: ../../finance/src/main/kotlin/net/corda/finance/schemas/CashSchemaV1.kt
:language: kotlin :language: kotlin
.. note:: If Cordapp needs to be portable between Corda OS (running against H2) and Corda Enterprise (running against a standalone database),
consider database vendors specific requirements.
Ensure that table and column names are compatible with the naming convention of the database vendors for which the Cordapp will be deployed,
e.g. for Oracle database, prior to version 12.2 the maximum length of table/column name is 30 bytes (the exact number of characters depends on the database encoding).
Identity mapping Identity mapping
---------------- ----------------
Schema entity attributes defined by identity types (``AbstractParty``, ``Party``, ``AnonymousParty``) are automatically Schema entity attributes defined by identity types (``AbstractParty``, ``Party``, ``AnonymousParty``) are automatically

14
docs/source/node-database.rst
View File

@ -22,21 +22,17 @@ configuration for PostgreSQL:
dataSourceProperties = { dataSourceProperties = {
dataSourceClassName = "org.postgresql.ds.PGSimpleDataSource" dataSourceClassName = "org.postgresql.ds.PGSimpleDataSource"
dataSource.url = "jdbc:postgresql://[HOST]:[PORT]/postgres" dataSource.url = "jdbc:postgresql://[HOST]:[PORT]/[DATABASE]"
dataSource.user = [USER] dataSource.user = [USER]
dataSource.password = [PASSWORD] dataSource.password = [PASSWORD]
} }
database = { database = {
transactionIsolationLevel = READ_COMMITTED transactionIsolationLevel = READ_COMMITTED
schema = [SCHEMA]
} }
Note that: Note that:
* Database schema name can be set in JDBC URL string e.g. currentSchema=myschema
* The ``database.schema`` property is optional * Database schema name must either match the ``dataSource.user`` value to end up
* The value of ``database.schema`` is not wrapped in double quotes and Postgres always treats it as a lower-case value
(e.g. ``AliceCorp`` becomes ``alicecorp``)
* If you provide a custom ``database.schema``, its value must either match the ``dataSource.user`` value to end up
on the standard schema search path according to the on the standard schema search path according to the
`PostgreSQL documentation <https://www.postgresql.org/docs/9.3/static/ddl-schemas.html#DDL-SCHEMAS-PATH>`_, or `PostgreSQL documentation <https://www.postgresql.org/docs/9.3/static/ddl-schemas.html#DDL-SCHEMAS-PATH>`_, or
the schema search path must be set explicitly for the user. the schema search path must be set explicitly for the user.
@ -56,15 +52,13 @@ an example node configuration for SQLServer:
} }
database = { database = {
transactionIsolationLevel = READ_COMMITTED transactionIsolationLevel = READ_COMMITTED
schema = [SCHEMA]
} }
jarDirs = ["[FULL_PATH]/sqljdbc_6.2/enu/"] jarDirs = ["[FULL_PATH]/sqljdbc_6.2/enu/"]
Note that: Note that:
* The ``database.schema`` property is optional and is ignored as of release 3.1.
* Ensure the directory referenced by jarDirs contains only one JDBC driver JAR file; by the default, * Ensure the directory referenced by jarDirs contains only one JDBC driver JAR file; by the default,
sqljdbc_6.2/enu/contains two JDBC JAR file for different Java versions. sqljdbc_6.2/enu/contains two JDBC JAR files for different Java versions.
Node database tables Node database tables
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^