Skip to content
Snippets Groups Projects
Verified Commit 43e68257 authored by Timm Fitschen's avatar Timm Fitschen
Browse files

RELEASE: Update CHANGELOG, replace some occurrences of "HeartDB"

parent 8e92725f
No related branches found
No related tags found
1 merge request!21Release v0.4.0
Pipeline #9015 passed
...@@ -32,6 +32,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ...@@ -32,6 +32,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed ### Changed
* The default session timeout changed from 10 min to 60 min. Please set it to
your needs via the server config option `SESSION_TIMEOUT_MS`.
### Deprecated ### Deprecated
### Removed ### Removed
......
...@@ -68,7 +68,7 @@ MYSQL_USER_NAME=caosdb ...@@ -68,7 +68,7 @@ MYSQL_USER_NAME=caosdb
# Password for the user # Password for the user
MYSQL_USER_PASSWORD=caosdb MYSQL_USER_PASSWORD=caosdb
# Schema of mysql procedures and tables which is required by this CaosDB instance. The versioning follows SemVer 2.0 specs. # Schema of mysql procedures and tables which is required by this CaosDB instance. The versioning follows SemVer 2.0 specs.
MYSQL_SCHEMA_VERSION=v5.0 MYSQL_SCHEMA_VERSION=v4.0.0
# -------------------------------------------------- # --------------------------------------------------
......
...@@ -5,8 +5,10 @@ ...@@ -5,8 +5,10 @@
# AbstractProperty Specification # AbstractProperty Specification
**Warning:** This specification is outdated. It is included to serve as a starting point for a more up-to-date description of the `Property` entity.
## Introduction ## Introduction
An `AbstractProperty` is one of the basal objects of HeartDB. An `AbstractProperty` is one of the basal objects of CaosDB.
An `AbstractProperty` MUST have the following _qualities_ (shortcut in brackets): An `AbstractProperty` MUST have the following _qualities_ (shortcut in brackets):
* a persistent id (`id`) * a persistent id (`id`)
* an unique name (`name`) * an unique name (`name`)
...@@ -39,7 +41,7 @@ An `AbstractProperty` is represented in xml by a `<Property/>` tag. It's _qualit ...@@ -39,7 +41,7 @@ An `AbstractProperty` is represented in xml by a `<Property/>` tag. It's _qualit
Depending on the purpose of the xml document (shall it represent an object in the database or an object _to be posted _to the database?) the `<Property/>` tag may actually have just a few of the mentioned "quality-attributes". Depending on the purpose of the xml document (shall it represent an object in the database or an object _to be posted _to the database?) the `<Property/>` tag may actually have just a few of the mentioned "quality-attributes".
### GET AbstractProperty ### GET AbstractProperty
Any xml representation of an `AbstractProperty` that is retrieved from the HeartDB Server MUST have exactly ONE of the following forms, depending on the `AbstractProperty's` type: Any xml representation of an `AbstractProperty` that is retrieved from the CaosDB Server MUST have exactly ONE of the following forms, depending on the `AbstractProperty's` type:
#### text #### text
<Property id="$id" name="$name" description="$description" generator="$generator" creator="$creator" created="$created" type="text" /> <Property id="$id" name="$name" description="$description" generator="$generator" creator="$creator" created="$created" type="text" />
...@@ -59,10 +61,10 @@ Any xml representation of an `AbstractProperty` that is retrieved from the Heart ...@@ -59,10 +61,10 @@ Any xml representation of an `AbstractProperty` that is retrieved from the Heart
<Property id="$id" name="$name" description="$description" generator="$generator" creator="$creator" created="$created" type="file" /> <Property id="$id" name="$name" description="$description" generator="$generator" creator="$creator" created="$created" type="file" />
'''General Notes: '''General Notes:
* If the called Property does not exist or if the Property called without permission, the HeartDB Server will return an Error. * If the called Property does not exist or if the Property called without permission, the CaosDB Server will return an Error.
### POST AbstractProperty ### POST AbstractProperty
Any xml representation of an `AbstractProperty` that is to be posted to the HeartDB server MUST have exactly ONE of the following forms, depending on the `AbstractProperty's` type: Any xml representation of an `AbstractProperty` that is to be posted to the CaosDB server MUST have exactly ONE of the following forms, depending on the `AbstractProperty's` type:
#### text #### text
<Property name="$name" description="$description" generator="$generator" type="text" /> <Property name="$name" description="$description" generator="$generator" type="text" />
...@@ -82,10 +84,10 @@ Any xml representation of an `AbstractProperty` that is to be posted to the Hear ...@@ -82,10 +84,10 @@ Any xml representation of an `AbstractProperty` that is to be posted to the Hear
<Property name="$name" description="$description" generator="$generator" type="file" /> <Property name="$name" description="$description" generator="$generator" type="file" />
*General Notes:* *General Notes:*
* The `AbstractProperty's` `id` and timestamp (`created`) will be generated by the HeartDB Server. * The `AbstractProperty's` `id` and timestamp (`created`) will be generated by the CaosDB Server.
* The `AbstractProperty's` creator will be determined by the HeartDB Server depending on it's policy configuration. * The `AbstractProperty's` creator will be determined by the CaosDB Server depending on it's policy configuration.
* Any given attribute beyond these will be *ignored*. * Any given attribute beyond these will be *ignored*.
* If the `<Property/>` tag isn't compliant with these the HeartDB Server will return an Error. * If the `<Property/>` tag isn't compliant with these the CaosDB Server will return an Error.
---- ----
## Examples ## Examples
......
# Fileserver # Fileserver
## Info ## Info
There are several ways to utilize the file server component of HeartDB. It is possible to upload a file or a whole folder including subfolders via HTTP and the _drop off box_. It is possible to download a file via HTTP identified by its ID or by its path in the internal file system. Furthermore, it is possible to get the files metadata via HTTP as an xml. There are several ways to utilize the file server component of CaosDB. It is possible to upload a file or a whole folder including subfolders via HTTP and the _drop off box_. It is possible to download a file via HTTP identified by its ID or by its path in the internal file system. Furthermore, it is possible to get the files metadata via HTTP as an xml.
## File upload ## File upload
### Drop off box ### Drop off box
The drop off box is a directory on the HeartDB server's local file system, specified in the `server.conf` file in the server's basepath (something like `~/HeartDB/server/server.conf`). The key in the `server.conf` is called `dropoffbox`. Since the drop off box directory is writable for all, users can push their files or complete folders via a `mv` or a `cp` (recommended!) in that folder. The server deletes files older than their maximum lifetime (24 hours by default, specified `in server.conf`). But within their lifetime a user can prompt the server to pick up the file (or folder) from the drop off box in order to transfer it to the internal file system. The drop off box is a directory on the CaosDB server's local file system, specified in the `server.conf` file in the server's basepath (something like `~/CaosDB/server/server.conf`). The key in the `server.conf` is called `dropoffbox`. Since the drop off box directory is writable for all, users can push their files or complete folders via a `mv` or a `cp` (recommended!) in that folder. The server deletes files older than their maximum lifetime (24 hours by default, specified `in server.conf`). But within their lifetime a user can prompt the server to pick up the file (or folder) from the drop off box in order to transfer it to the internal file system.
Now, the user may send a pick up request to `POST http://host:port/mpidsserver/FilesDropOff` with a similar body: Now, the user may send a pick up request to `POST http://host:port/mpidsserver/FilesDropOff` with a similar body:
...@@ -38,9 +38,9 @@ where ...@@ -38,9 +38,9 @@ where
There is an example on file upload using cURL described in detail in [the curl section of this There is an example on file upload using cURL described in detail in [the curl section of this
documentation](../administration/curl-access.md). documentation](../administration/curl-access.md).
File upload via HTTP is implemented in a [rfc1867](http://www.ietf.org/rfc/rfc1867.txt) consistent way. This is a de-facto standard that defines a file upload as a part of an HTML form submission. This concept shall not be amplified here. But it has to be noticed that this protocol is not designed for uploads of complete structured folders. Therefore the HeartDB file components have to impose that structure on the upload protocol. File upload via HTTP is implemented in a [rfc1867](http://www.ietf.org/rfc/rfc1867.txt) consistent way. This is a de-facto standard that defines a file upload as a part of an HTML form submission. This concept shall not be amplified here. But it has to be noticed that this protocol is not designed for uploads of complete structured folders. Therefore the CaosDB file components have to impose that structure on the upload protocol.
HeartDB's file upload resource does exclusively accept POST requests of MIME media type `multipart/form-data`. The first part of each POST body is expected to be a form-data text field, containing information about the files to be uploaded. It has to meet the following requirements: CaosDB's file upload resource does exclusively accept POST requests of MIME media type `multipart/form-data`. The first part of each POST body is expected to be a form-data text field, containing information about the files to be uploaded. It has to meet the following requirements:
* `Content-type: text/plain; charset=UTF-8` * `Content-type: text/plain; charset=UTF-8`
* `Content-disposition: form-data; name="FileRepresentation"` * `Content-disposition: form-data; name="FileRepresentation"`
......
# RecordType # RecordType
**Warning:** This specification is outdated. It is included to serve as a starting point for a more up-to-date description of the `RecordType` entity.
## Overview ## Overview
RecordTypes function as templates for [[Record|Records]], they provide a description for a type of Record and define which [[Property|Properties]] should be present. Properties come with an _importance_ attribute which tells the user or client program how strongly necessary the Property is. (As all other entities,) RecordTypes can be inherited from other RecordTypes (or any Entities). When RecordTypes inherit from other RecordTypes, the _inheritance_ flag tells which properties shall be inherited. RecordTypes function as templates for [[Record|Records]], they provide a description for a type of Record and define which [[Property|Properties]] should be present. Properties come with an _importance_ attribute which tells the user or client program how strongly necessary the Property is. (As all other entities,) RecordTypes can be inherited from other RecordTypes (or any Entities). When RecordTypes inherit from other RecordTypes, the _inheritance_ flag tells which properties shall be inherited.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment