Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-julialib
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-julialib
Commits
fbb232a9
Commit
fbb232a9
authored
3 years ago
by
florian
Browse files
Options
Downloads
Patches
Plain Diff
DOC: Add placeholder for examples
parent
168e4c26
No related branches found
No related tags found
1 merge request
!6
DOC: Add sections to documentation
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/make.jl
+1
-0
1 addition, 0 deletions
docs/make.jl
docs/src/examples.md
+29
-0
29 additions, 0 deletions
docs/src/examples.md
docs/src/index.md
+3
-2
3 additions, 2 deletions
docs/src/index.md
with
33 additions
and
2 deletions
docs/make.jl
+
1
−
0
View file @
fbb232a9
...
...
@@ -7,6 +7,7 @@ makedocs(
pages
=
[
"Home"
=>
"index.md"
,
"Getting started"
=>
"README_SETUP.md"
,
"examples.md"
,
"Library"
=>
"api.md"
,
],
)
This diff is collapsed.
Click to expand it.
docs/src/examples.md
0 → 100644
+
29
−
0
View file @
fbb232a9
# Examples
**TODO**
Fill the sections below once the parts have been implemented.
## Connect to a CaosDB server
See also the hints on the
[
Installation
](
@ref
)
and set-up of
CaosDB.jl. CaosDB.jl makes use of the C++ client of CaosDB, so in
order to connect to a CaosDB server you first have to configure the
connection via a configuration file as explained in the
[
documentation
of CaosDB's C++
client
](
https://docs.indiscale.com/caosdb-cpplib
)
. Once the
configuration is set up, connecting to the server is as easy as
```
julia
using
CaosDB
connection
=
CaosDB
.
Connection
.
connect
()
```
which will establish a connection and print the version of the server
you are connected to.
## Retrieve a Record
## Execute queries
## Insert, update, and delete entities
## Download a file
This diff is collapsed.
Click to expand it.
docs/src/index.md
+
3
−
2
View file @
fbb232a9
...
...
@@ -3,10 +3,11 @@
Welcome to CaosDB.jl, the Julia Client for
[
CaosDB
](
https://caosdb.org
)
, the opensource research data management
system. In here you find instruction on how to
[
Set-up
CaosDB.jl
](
@ref
)
and an overview of
[
CaosDB.jl's API
](
@ref
)
.
CaosDB.jl
](
@ref
)
, some introductory
[
Examples
](
@ref
)
, and an overview
of
[
CaosDB.jl's API
](
@ref
)
.
## Contents
```
@contents
Pages = ["README_SETUP.md", "api.md"]
Pages = ["README_SETUP.md",
"examples.md",
"api.md"]
```
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