Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-pylib
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
caosdb
Software
caosdb-pylib
Commits
bee82d3c
Commit
bee82d3c
authored
3 years ago
by
Alexander Schlemmer
Browse files
Options
Downloads
Patches
Plain Diff
DOC: added more documentation for the high level API
parent
fad37506
No related branches found
Branches containing commit
No related tags found
Tags containing commit
2 merge requests
!57
RELEASE 0.7.3
,
!52
F refactor high level api
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/doc/high_level_api.org
+28
-0
28 additions, 0 deletions
src/doc/high_level_api.org
with
28 additions
and
0 deletions
src/doc/high_level_api.org
+
28
−
0
View file @
bee82d3c
...
...
@@ -91,3 +91,31 @@ print(str(obj))
* Concepts
As described in the section [[Quickstart]] the two functions "convert_to_python_object" and "convert_to_entity" convert
entities beetween the high level and the standard representation.
The high level entities are represented using the following classes from the module caosdb.high_level_api:
- CaosDBPythonEntity: Base class of the following entity classes.
- CaosDBPythonRecord
- CaosDBPythonRecordType
- CaosDBPythonProperty
- CaosDBPythonMultiProperty: **WARNING** Not implemented yet.
- CaosDBPythonFile: Used for file entities and provides an additional "download" function for being able to directly retrieve files from CaosDB.
In addition, there are the following helper structures which are realized as Python data classes:
- CaosDBPropertyMetaData: For storing meta data about properties.
- CaosDBPythonUnresolved: The base class of unresolved "things".
- CaosDBPythonUnresolvedParent: Parents of entities are stored as unresolved parents by default, storing an id or a name of a parent (or both).
- CaosDBPythonUnresolvedReference: An unresolved reference is a reference property with an id which has not (yet) been resolved to an Entity.
The function "resolve_references" can be used to recursively replace CaosDBPythonUnresolvedReferences into members of type CaosDBPythonRecords
or CaosDBPythonFile.
Each property stored in a CaosDB record corresponds to:
- a member attribute of CaosDBPythonRecord **and**
- an entry in a dict called "metadata" storing a CaosDBPropertyMetadata object with the following information about proeprties:
- unit
- datatype
- description
- id
- importance
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment