Changeset: 28f6e11854f6 for MonetDB URL: https://dev.monetdb.org/hg/MonetDB?cmd=changeset;node=28f6e11854f6 Modified Files: documentation/monetdbe/introduction.rst documentation/monetdbe/monetdbe_api.rst Branch: default Log Message:
Another pass over the documentation diffs (140 lines): diff --git a/documentation/monetdbe/introduction.rst b/documentation/monetdbe/introduction.rst --- a/documentation/monetdbe/introduction.rst +++ b/documentation/monetdbe/introduction.rst @@ -10,7 +10,7 @@ functionality. ``An embedded database system is a database management system (DBMS) which is tightly integrated with an application software that requires access to stored data, such that the database system is "hidden" from the application’s end-user -and requires little or no ongoing maintenance. `` `[wikipedia] https://en.wikipedia.org/wiki/Embedded_database`_ +and requires little or no ongoing maintenance. `` `wikipedia <https://en.wikipedia.org/wiki/Embedded_database>` The embedded database market has for a long time been dominated by traditional row-stores, often with limited SQL functionality, scalability or performance. @@ -27,7 +27,7 @@ data analytics and machine learning, wit A strong embeddedness with the application to easily use the UDFs at close range without overhead in data exchanges. How we solved it ---------------- +---------------- The solution brought to you is illustrated below. On the left we see MonetDB in the role of a client/server architecture as it has worked all along. @@ -56,7 +56,8 @@ A single library to be linked into the a How does it work? ----------------- +----------------- + MonetDBe encapsulates the full SQL functionality offered by MonetDB. To achieve this, we had to create a single shared library (libmonetdbe) to expose the main sql interfaces using a small api (monetdbe.h). @@ -64,6 +65,7 @@ It is an integral component of the serve What to expect? --------------- + The MonetDBe library supports three different storage schemes. A light-weight scheme for small databases confined to main memory, i.e. connect(‘ :inmemory:’). The maximum footprint can be set explicitly or is derived from the host (VM) resource limits. diff --git a/documentation/monetdbe/monetdbe_api.rst b/documentation/monetdbe/monetdbe_api.rst --- a/documentation/monetdbe/monetdbe_api.rst +++ b/documentation/monetdbe/monetdbe_api.rst @@ -7,7 +7,7 @@ error messages encountered during the in exception message thrown by the MonetDB kernel. General considerations ---------------------- +---------------------- There can be a single :memory: database or local persistent database open at a time. As soon as you open another database its content is gone. It is possible to have multiple connections open with full-fledge MonetDB servers. @@ -17,25 +17,23 @@ Data Types The API wraps the internal data types to those more convenient for programming directly in C. - | MonetDBe type | MonetDB internal type | | ----------------------- | --------------------- | -|int8_t | bool| -|int8_t | int8_t| -|int16_t | int16_t| -|int32_t | int32_t| -|int64_t | int64_t| -|__int128 | int128_t| -|float | float| -|double | double| -|char * | str| -|monetdbe_data_blob | blob| -|monetdbe_data_date | date| -|monetdbe_data_time | time| -|monetdbe_data_timestamp | timestamp| +| int8_t | bool| +| int8_t | int8_t| +| int16_t | int16_t| +| int32_t | int32_t| +| int64_t | int64_t| +| __int128 | int128_t| +| float | float| +| double | double| +| char * | str| +| monetdbe_data_blob | blob| +| monetdbe_data_date | date| +| monetdbe_data_time | time| +| monetdbe_data_timestamp | timestamp| | ----------------------- | --------------------- | - Connection and server options ----------------------------- @@ -53,7 +51,6 @@ Connection and server options From here on the connection can not be used anymore to pass queries and any pending result set is cleaned up. Be aware that the content of an ':memory:' database is discarded. - Transaction management ---------------------- @@ -108,22 +105,20 @@ Query prepare, bind, execute Remove the execution pland and all bound variables. - Database append --------------- +-=------------- .. c:function:: char* monetdbe_append(monetdbe_database db, const char* schema, const char* table, monetdbe_result *result, size_t column_count); The result set obtained from any query can be assigned to a new database table. - Backup and restore ------------------ .. c:function:: char* monetdbe_backup(monetdbe_database db, char *backupfile); [TODO] Dump a :memory: database as a collection of SQL statements on a local file -.. c:function:: monetdbe_export char* monetdbe_dump_table(monetdbe_database db, const char *schema_name, const char *table_name, const char *backupfile); +.. c:function:: char* monetdbe_dump_table(monetdbe_database db, const char *schema_name, const char *table_name, const char *backupfile); [TODO] Dump a specific tables @@ -131,7 +126,6 @@ Backup and restore [TODO] Restore a SQL dump to initialize the ':memory:' case. This is simular to loading a SQL script. - Miscellaneous ------------- @@ -147,6 +141,6 @@ Miscellaneous Caveats and errors ------------------ -If the program with the monetdbe.so library is killed forcefully then there may be some garbage files left behind in the -database directory. In particular, you may have to remove the .gdk_lock and uuid files. + If the program with the monetdbe.so library is killed forcefully then there may be some garbage files left behind in the + database directory. In particular, you may have to remove the .gdk_lock and uuid files. _______________________________________________ checkin-list mailing list [email protected] https://www.monetdb.org/mailman/listinfo/checkin-list
