Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-cpplib
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
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-cpplib
Commits
7748c0d9
Verified
Commit
7748c0d9
authored
3 years ago
by
Daniel Hornung
Browse files
Options
Downloads
Patches
Plain Diff
MAINT: Fixed a few documentation issues.
parent
71bbefe1
No related branches found
No related tags found
1 merge request
!35
DOC: Make `make conan` more prominent.
Pipeline
#19311
passed
3 years ago
Stage: info
Stage: setup
Stage: test
Stage: deploy
Pipeline: caosdb-cppinttest
#19313
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
doc/Examples.rst
+9
-6
9 additions, 6 deletions
doc/Examples.rst
doc/conf.py.in
+1
-1
1 addition, 1 deletion
doc/conf.py.in
with
10 additions
and
7 deletions
doc/Examples.rst
+
9
−
6
View file @
7748c0d9
...
...
@@ -19,6 +19,7 @@ You can print the full version of the server that you are connected to (and
therby test the connection) via:
.. code:: cpp
// get version info of the server
connection.RetrieveVersionInfo()
const auto &v_info = connection->GetVersionInfo();
...
...
@@ -57,8 +58,9 @@ you want to retrieve an Entity with id=123. This is done via
You can then use the getter methods like :cpp:any:`GetId<caosdb::entity::Entity::GetId>`,
:cpp:any:`GetParents<caosdb::entity::Entity::GetParents>`, or :cpp:any:`GetProperties`<caosdb::entity::Entity::GetProperties>` to get the
name, the parents, or the properties of the retrieved entity.
:cpp:any:`GetParents<caosdb::entity::Entity::GetParents>`, or
:cpp:any:`GetProperties`<caosdb::entity::Entity::GetProperties>` to get the name, the parents, or
the properties of the retrieved entity.
Retrieving multiple entities works in the same way. Type
...
...
@@ -83,9 +85,9 @@ transaction manually. This is done by
transaction->RetrieveById("1233");
auto status = transaction->Execute();
A result set can be obtained
via
:cpp:any:`GetResultSet`<caosdb::transaction::Transaction::GetResultSet>` which contains the
resulting entities
and can, e.g., be checked for length.
A result set can be obtained
via
:cpp:any:`GetResultSet`<caosdb::transaction::Transaction::GetResultSet>` which contains the
resulting entities
and can, e.g., be checked for length.
Execute queries
---------------
...
...
@@ -147,6 +149,7 @@ Insert, update and delete operations function the same way. The respective
task is added to a transaction and the transaction is executed.
.. code:: cpp
const auto &connection =
caosdb::connection::ConnectionManager::GetDefaultConnection();
...
...
@@ -202,7 +205,7 @@ task is added to a transaction and the transaction is executed.
Up- and Download a file
---------------
---------------
--------
.. code:: cpp
...
...
This diff is collapsed.
Click to expand it.
doc/conf.py.in
+
1
−
1
View file @
7748c0d9
...
...
@@ -46,7 +46,7 @@ extensions = [
'sphinx_sitemap',
'sphinx.ext.inheritance_diagram',
'breathe',
"recommonmark" # For markdown files.
"recommonmark"
,
# For markdown files.
]
# Add any paths that contain templates here, relative to this directory.
...
...
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