Skip to content

Commit

Permalink
adapt documentation about update and commit
Browse files Browse the repository at this point in the history
  • Loading branch information
shenchenruwo committed Nov 8, 2024
1 parent 766686b commit 880331e
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 5 deletions.
2 changes: 1 addition & 1 deletion sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ For further examples and tutorials, check out the `basyx.aas.examples`-package.
* [`tutorial_storage`](./basyx/aas/examples/tutorial_storage.py): Manage a larger number of Asset Administration Shells in an ObjectStore and resolve references
* [`tutorial_serialization_deserialization`](./basyx/aas/examples/tutorial_serialization_deserialization.py): Use the JSON and XML serialization/deserialization for single objects or full standard-compliant files
* [`tutorial_aasx`](./basyx/aas/examples/tutorial_aasx.py): Export Asset Administration Shells with related objects and auxiliary files to AASX package files
* [`tutorial_backend_couchdb`](./basyx/aas/examples/tutorial_backend_couchdb.py): Use the *Backends* interface (`update()/commit()` methods) to manage and retrieve AAS objects in a CouchDB document database
* [`tutorial_backend_couchdb`](./basyx/aas/examples/tutorial_backend_couchdb.py): Use the *CouchDBObjectStore* to manage and retrieve AAS objects in a CouchDB document database


### Documentation
Expand Down
3 changes: 1 addition & 2 deletions sdk/basyx/aas/backend/couchdb.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ def register_credentials(url: str, username: str, password: str):
.. Warning::
Do not use this function, while other threads may be accessing the credentials via the
:class:`~.CouchDBObjectStore` or update or commit functions of :class:`~.basyx.aas.model.base.Referable`
objects!
:class:`~.CouchDBObjectStore`!
:param url: Toplevel URL
:param username: Username to that CouchDB instance
Expand Down
3 changes: 1 addition & 2 deletions sdk/basyx/aas/examples/tutorial_storage.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,7 @@
# persistent memory (i.e. on hard disk). In this case, you may choose the `CouchDBObjectStore` from
# `aas.backends.couchdb` to use a CouchDB database server as persistent storage. Both ObjectStore implementations
# provide the same interface. In addition, the CouchDBObjectStores allows synchronizing the local object with the
# database via a Backend and the update()/commit() mechanism. See the `tutorial_backend_couchdb.py` for more
# information.
# database via a Backend. See the `tutorial_backend_couchdb.py` for more information.
obj_store: model.DictObjectStore[model.Identifiable] = model.DictObjectStore()

# step 2.2: add submodel and asset administration shell to store
Expand Down

0 comments on commit 880331e

Please sign in to comment.