Skip to content

Commit

Permalink
Improve DocumentDeleteQuery documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
  • Loading branch information
otaviojava committed May 4, 2022
1 parent 82a1f20 commit 90e9638
Showing 1 changed file with 7 additions and 3 deletions.
Expand Up @@ -26,7 +26,7 @@

/**
* A unit that has the columnFamily and condition to delete from conditions
*
* <p>
* This instance will be used on:
* <p>{@link DocumentCollectionManager#delete(DocumentDeleteQuery)}</p>
*/
Expand Down Expand Up @@ -55,7 +55,9 @@ public interface DocumentDeleteQuery {
List<String> getDocuments();

/**
* Creates a delete query to Document
* It starts the first step of {@link DocumentDelete} API using a fluent-API way.
* This first step will inform the fields to delete in the query instead of the whole record.
* This behavior might be different for each NoSQL database provider; therefore, it might be ignored for some implementations.
*
* @param documents - The column fields to query, optional.
* @return a new {@link DocumentDelete} instance
Expand All @@ -66,7 +68,9 @@ static DocumentDelete delete(String... documents) {
}

/**
* Creates a delete query to Column
* It starts the first step of {@link DocumentDelete} API using a fluent-API way.
* Once there is no field, it will remove the whole record instead of some fields on the database.
*
* @return a new {@link DocumentDelete} instance
* @throws NullPointerException when there is a null element
*/
Expand Down

0 comments on commit 90e9638

Please sign in to comment.