Skip to content
Snippets Groups Projects
Commit 6a4dddbd authored by Florian Spreckelsen's avatar Florian Spreckelsen
Browse files

DOC: Add short section on loadFiles to utilities documentation

parent 0b01d3f0
No related branches found
No related tags found
2 merge requests!128MNT: Added a warning when column metadata is not configured, and a better...,!113F doc loadfiles
Pipeline #53797 passed
......@@ -35,3 +35,24 @@ behavior can be changed by initializing the ``TableImporter`` with
:py:class:`~caosadvancedtools.datainconsistency.DataInconsistencyError` is
raised when an empty field is encountered in a column with an non-nullable
integer datatype.
The loadfiles module and executable
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
For making files available to the LinkAhead server as File entities
(see also the server's `file server
<https://docs.indiscale.com/caosdb-server/specification/Fileserver.html>`_
documentation), the LinkAhead Advanced User tools provide the
:py:mod:`~caosadvancedtools.loadFiles` module and a
`linkahead-loadfiles` executable. Both operate on a path as seen by
the LinkAhead server (i.e., a path within the Docker container in the
typical LinkAhead Control setup) and can be further specified to
exclude or exclude specific files.
Execute
.. code-block:: sh
linkahead-loadfiles --help
for more information and examples.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment