diff options
| author |   Rob Daugherty <rd472p@att.com> | 2018-11-05 10:23:04 -0500 |
|---|---|---|
| committer | Rob Daugherty <rd472p@att.com> | 2018-11-05 10:33:13 -0500 |
| commit | 95d22d7491ea365fdc4525e44d484c73c33e16a1 (patch) | |
| tree | a5fdb7de3f14b345db760463cec8cee130b5b116 /mdbc-server/src/main/javadoc | |
| parent | 8dca3aebe55502ab35402da6ec7123bd3de7694d (diff) | |
Modularized mdbc build
The mdbc pom should inherit from oparent.
The top-level pom should not build the jar directly.
It should be a parent pom for mdbc submodules.
The first submodule will be called mdbc-server.
Note: the "mdbc" jar will now be called "mdbc-server".
Change-Id: I4456e659b7494641e5b3cefd540eb62a149b79a4
Issue-ID: MUSIC-175
Signed-off-by: Rob Daugherty <rd472p@att.com>
Diffstat (limited to 'mdbc-server/src/main/javadoc')
| -rwxr-xr-x | mdbc-server/src/main/javadoc/overview.html | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/mdbc-server/src/main/javadoc/overview.html b/mdbc-server/src/main/javadoc/overview.html new file mode 100755 index 0000000..0be8c38 --- /dev/null +++ b/mdbc-server/src/main/javadoc/overview.html @@ -0,0 +1,37 @@ +<!DOCTYPE HTML> +<html> +<body> + +<p> +MDBC is a JDBC driver that provides an application programmer a way to automatically copy +data to and from a running copy of MUSIC/Cassandra. +The driver does this by intercepting all DELETES, INSERTS, SELECTS, and UPDATES and copying +modified table rows to and from Cassandra. +</p> +<p> +MDBC can automatically adopt to the database in use, as well as the style of MUSIC interaction, +by the use of "mixins". Each JDBC Connection via MDBC specifies two mixins to use: +</p> +<ul> +<li>a Mixin that conforms to the {@link org.onap.music.mdbc.mixins.MusicInterface} specification +for communicating with MUSIC/Cassandra.</li> +<li>a Mixin that conforms to the {@link org.onap.music.mdbc.mixins.DBInterface} specification +for communicating with the underlying database in use.</li> +</ul> +<p> +More details are provided on the package pages for +<code>org.onap.music.mdbc</code> and +<code>org.onap.music.mdbc.mixins</code>. +</p> +<h2>Limitations</h2> +There are several limitations to the use of MDBC: +<ul> +<li>The <code>java.sql.Statement.executeBatch()</code> method is not supported by MDBC. +It is not prohibited either; your results will be unpredictable.</li> +<li>When used with a DB server, there is some delay as dirty row information is copied +from a table in the database, to the dirty table in Cassandra. This opens a window +during which all sorts of mischief may occur.</li> +</ul> + +</body> +</html> |