MySQL Connector/J 9.2.0 · com.mysql.cj.xdevapi.ModifyStatement

Method Summary

Modifier and Type	Method and Description
public ModifyStatement	Returns: `ModifyStatement` arrayAppend(String document path to the array field docPath, Object value to append value) Append a value to the specified array.
public ModifyStatement	Returns: `ModifyStatement` arrayInsert(String document path to the array field docPath, Object value to insert value) Insert a value into the specified array.
public ModifyStatement	Returns: `ModifyStatement` change(String document path to the given value docPath, Object value to set value) Add an update to the statement setting the field, if it exists at the document path, to the given value.
public ModifyStatement	Returns: `ModifyStatement` limit(long limit numberOfRows) Add/replace the document limit for this statement.
public ModifyStatement	Returns: `ModifyStatement` patch(DbDoc patch object document) Takes in a patch object and applies it on all documents matching the modify() filter, using the JSON_MERGE_PATCH() function.
public ModifyStatement	Returns: `ModifyStatement` patch(String patch object document) Takes in a document patch and applies it on all documents matching the modify() filter, using the JSON_MERGE_PATCH() function.
public ModifyStatement	Returns: `ModifyStatement` set(String document path to the given value docPath, Object value to set value) Add an update to the statement setting the field as the document path to the given value for all documents matching the search criteria.
public ModifyStatement	Returns: `ModifyStatement` sort(String... sort expression sortFields) Add/replace the order specification for this statement.
public ModifyStatement	Returns: `ModifyStatement` unset(String... one or more field names docPath) Nullify the given fields.

Inherited from com.mysql.cj.xdevapi.Statement:: bind bind bind bind clearBindings execute executeAsync

Method Detail

arrayAppend back to summary

arrayAppend	back to summary
public ModifyStatement arrayAppend(String docPath, Object value) Append a value to the specified array. Parameters docPath:String document path to the array field value:Object value to append Returns:ModifyStatement `ModifyStatement`

public ModifyStatement arrayAppend(String docPath, Object value)

Append a value to the specified array.

Parameters

docPath:String: document path to the array field
value:Object: value to append

Returns:ModifyStatement

ModifyStatement

arrayInsert back to summary

arrayInsert	back to summary
public ModifyStatement arrayInsert(String docPath, Object value) Insert a value into the specified array. Parameters docPath:String document path to the array field value:Object value to insert Returns:ModifyStatement `ModifyStatement`

public ModifyStatement arrayInsert(String docPath, Object value)

Insert a value into the specified array.

Parameters

docPath:String: document path to the array field
value:Object: value to insert

Returns:ModifyStatement

ModifyStatement

change back to summary

change	back to summary
public ModifyStatement change(String docPath, Object value) Add an update to the statement setting the field, if it exists at the document path, to the given value. Parameters docPath:String document path to the given value value:Object value to set Returns:ModifyStatement `ModifyStatement`

public ModifyStatement change(String docPath, Object value)

Add an update to the statement setting the field, if it exists at the document path, to the given value.

Parameters

docPath:String: document path to the given value
value:Object: value to set

Returns:ModifyStatement

ModifyStatement

limit back to summary

limit	back to summary
public ModifyStatement limit(long numberOfRows) Add/replace the document limit for this statement. Parameters numberOfRows:long limit Returns:ModifyStatement `ModifyStatement`

public ModifyStatement limit(long numberOfRows)

Add/replace the document limit for this statement.

Parameters

numberOfRows:long: limit

Returns:ModifyStatement

ModifyStatement

patch back to summary

patch	back to summary
public ModifyStatement patch(DbDoc document) Takes in a patch object and applies it on all documents matching the modify() filter, using the JSON_MERGE_PATCH() function. Please note that `DbDoc` does not support expressions as a field values, please use `patch(String)` method if you need such functionality. Parameters document:DbDoc patch object Returns:ModifyStatement `ModifyStatement`

public ModifyStatement patch(DbDoc document)

Takes in a patch object and applies it on all documents matching the modify() filter, using the JSON_MERGE_PATCH() function. Please note that DbDoc does not support expressions as a field values, please use patch(String) method if you need such functionality.

Parameters

document:DbDoc: patch object

Returns:ModifyStatement

ModifyStatement

patch back to summary

patch	back to summary
public ModifyStatement patch(String document) Takes in a document patch and applies it on all documents matching the modify() filter, using the JSON_MERGE_PATCH() function. A document patch is similar to a JSON object, with the key difference that document field values can be nested expressions in addition to literal values. Example: collection.modify("_id = :id") .patch("{\"zip\": address.zip-300000, \"street\": CONCAT($.name, '''s street: ', $.address.street)}") .bind("id", "2").execute(); Parameters document:String patch object Returns:ModifyStatement `ModifyStatement`

public ModifyStatement patch(String document)

Takes in a document patch and applies it on all documents matching the modify() filter, using the JSON_MERGE_PATCH() function. A document patch is similar to a JSON object, with the key difference that document field values can be nested expressions in addition to literal values.
Example:
collection.modify("_id = :id")
.patch("{\"zip\": address.zip-300000, \"street\": CONCAT($.name, '''s street: ', $.address.street)}")
.bind("id", "2").execute();

Parameters

document:String: patch object

Returns:ModifyStatement

ModifyStatement

set back to summary

set	back to summary
public ModifyStatement set(String docPath, Object value) Add an update to the statement setting the field as the document path to the given value for all documents matching the search criteria. Parameters docPath:String document path to the given value value:Object value to set Returns:ModifyStatement `ModifyStatement`

public ModifyStatement set(String docPath, Object value)

Add an update to the statement setting the field as the document path to the given value for all documents matching the search criteria.

Parameters

docPath:String: document path to the given value
value:Object: value to set

Returns:ModifyStatement

ModifyStatement

sort back to summary

sort	back to summary
public ModifyStatement sort(String... sortFields) Add/replace the order specification for this statement. Parameters sortFields:String[] sort expression Returns:ModifyStatement `ModifyStatement`

public ModifyStatement sort(String... sortFields)

Add/replace the order specification for this statement.

Parameters

sortFields:String[]: sort expression

Returns:ModifyStatement

ModifyStatement

unset back to summary

unset	back to summary
public ModifyStatement unset(String... docPath) Nullify the given fields. Parameters docPath:String[] one or more field names Returns:ModifyStatement `ModifyStatement`

public ModifyStatement unset(String... docPath)

Nullify the given fields.

Parameters

docPath:String[]: one or more field names

Returns:ModifyStatement

ModifyStatement

public Interface ModifyStatement

Method Summary

Method Detail