You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by ze...@apache.org on 2024/01/04 11:58:47 UTC

(streampipes) branch dev updated: docs: Add documentation to GenericStorageImpl.find (#2387)

This is an automated email from the ASF dual-hosted git repository.

zehnder pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/streampipes.git


The following commit(s) were added to refs/heads/dev by this push:
     new 9c63a8c28 docs: Add documentation to GenericStorageImpl.find (#2387)
9c63a8c28 is described below

commit 9c63a8c283adc98d6e346494ddf707c521c1ab8e
Author: Philipp Zehnder <te...@users.noreply.github.com>
AuthorDate: Thu Jan 4 12:58:41 2024 +0100

    docs: Add documentation to GenericStorageImpl.find (#2387)
---
 .../apache/streampipes/storage/couchdb/impl/GenericStorageImpl.java   | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/streampipes-storage-couchdb/src/main/java/org/apache/streampipes/storage/couchdb/impl/GenericStorageImpl.java b/streampipes-storage-couchdb/src/main/java/org/apache/streampipes/storage/couchdb/impl/GenericStorageImpl.java
index f8f6942ef..3cd2ea720 100644
--- a/streampipes-storage-couchdb/src/main/java/org/apache/streampipes/storage/couchdb/impl/GenericStorageImpl.java
+++ b/streampipes-storage-couchdb/src/main/java/org/apache/streampipes/storage/couchdb/impl/GenericStorageImpl.java
@@ -71,6 +71,10 @@ public class GenericStorageImpl implements IGenericStorage {
     return result;
   }
 
+  /**
+   * This endpoint uses /db/_find endpoint of CouchDB to query documents.
+   * You can find the docuemntation for the parameters at https://docs.couchdb.org/en/stable/api/database/find.html
+   */
   @Override
   public List<Map<String, Object>> find(String appDocType,
                                         Map<String, Object> query) throws IOException {