mirror of
https://github.com/corda/corda.git
synced 2025-01-29 15:43:55 +00:00
Formatting and typos. Groups API docs in sidebar. Renames Persistence to API: Persistence and fixes some links.
This commit is contained in:
parent
d16813597c
commit
d9d20f2215
@ -1,5 +1,5 @@
|
||||
API overview
|
||||
============
|
||||
API
|
||||
===
|
||||
|
||||
This section describes the APIs that are available for the development of CorDapps:
|
||||
|
@ -1,5 +1,11 @@
|
||||
Persistence
|
||||
===========
|
||||
.. highlight:: kotlin
|
||||
.. raw:: html
|
||||
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/codesets.js"></script>
|
||||
|
||||
API: Persistence
|
||||
================
|
||||
|
||||
Corda offers developers the option to expose all or some part of a contract state to an *Object Relational Mapping*
|
||||
(ORM) tool to be persisted in a RDBMS. The purpose of this is to assist *vault* development by effectively indexing
|
||||
@ -11,9 +17,9 @@ The ORM mapping is specified using the `Java Persistence API <https://en.wikiped
|
||||
in the node's local vault as part of a transaction.
|
||||
|
||||
.. note:: Presently the node includes an instance of the H2 database but any database that supports JDBC is a
|
||||
candidate and the node will in the future support a range of database implementations via their JDBC drivers. Much
|
||||
of the node internal state is also persisted there. You can access the internal H2 database via JDBC, please see the
|
||||
info in ":doc:`node-administration`" for details.
|
||||
candidate and the node will in the future support a range of database implementations via their JDBC drivers. Much
|
||||
of the node internal state is also persisted there. You can access the internal H2 database via JDBC, please see the
|
||||
info in ":doc:`node-administration`" for details.
|
||||
|
||||
Schemas
|
||||
-------
|
||||
|
@ -116,7 +116,7 @@ Other interfaces
|
||||
``ContractState`` has several more sub-interfaces that can optionally be implemented:
|
||||
|
||||
* ``QueryableState``, which allows the state to be queried in the node's database using SQL (see
|
||||
:doc:`persistence`)
|
||||
:doc:`api-persistence`)
|
||||
* ``SchedulableState``, which allows us to schedule future actions for the state (e.g. a coupon on a bond) (see
|
||||
:doc:`event-scheduling`)
|
||||
|
||||
|
@ -6,11 +6,5 @@ Building a CorDapp
|
||||
|
||||
cordapp-overview
|
||||
writing-cordapps
|
||||
api
|
||||
api-states
|
||||
api-contracts
|
||||
api-transactions
|
||||
api-flows
|
||||
api-service-hub
|
||||
api-core-types
|
||||
api-index
|
||||
cheat-sheet
|
@ -1,5 +1,5 @@
|
||||
CorDapp overview
|
||||
================
|
||||
What is a CorDapp?
|
||||
==================
|
||||
|
||||
Corda is a platform. Its functionality is extended by developers through the writing of Corda distributed
|
||||
applications (CorDapps). CorDapps are installed at the level of the individual node, rather than on the network
|
||||
|
@ -279,7 +279,7 @@ Here's an example of it in action from ``FixingFlow.Fixer``.
|
||||
Testing
|
||||
-------
|
||||
|
||||
When unit testing we make use of the ``MockNetwork`` which allows us to create ``MockNode``s, which are simplified nodes
|
||||
suitable for tests. One feature we lose (and which is not suitable in unit testing anyway) is the node's ability to scan
|
||||
and automatically install orcales it finds in the CorDapp jars. Instead when working with ``MockNode`` use the
|
||||
``installCordaService`` method to manually install the oracle on the relevant node.
|
||||
When unit testing, we make use of the ``MockNetwork`` which allows us to create ``MockNode`` instances. A ``MockNode``
|
||||
is a simplified node suitable for tests. One feature that isn't available (and which is not suitable in unit testing
|
||||
anyway) is the node's ability to scan and automatically install oracles it finds in the CorDapp jars. Instead, when
|
||||
working with ``MockNode``, use the ``installCordaService`` method to manually install the oracle on the relevant node.
|
Loading…
x
Reference in New Issue
Block a user