Package liquibase.ext.mongodb.statement

Class FindOneAndUpdateStatement

java.lang.Object

liquibase.statement.AbstractSqlStatement

liquibase.nosql.statement.AbstractNoSqlStatement

liquibase.ext.mongodb.statement.AbstractMongoStatement

liquibase.ext.mongodb.statement.AbstractRunCommandStatement

liquibase.ext.mongodb.statement.FindOneAndUpdateStatement

All Implemented Interfaces:

NoSqlExecuteStatement<MongoLiquibaseDatabase>, NoSqlUpdateStatement<MongoLiquibaseDatabase>, liquibase.statement.SqlStatement

public class FindOneAndUpdateStatement
extends AbstractRunCommandStatement
implements NoSqlUpdateStatement<MongoLiquibaseDatabase>

Finds and updates a single document via the database runCommand method NOTE: This does not return the original document, instead returns 1 if a document was updated, else 0

For a list of supported options see the reference page:

See Also:

findAndModify

Field Summary

Fields

Modifier and Type	Field	Description
static String	QUERY
static String	RUN_COMMAND_NAME
static String	SORT
static String	UPDATE
static String	VALUE

Fields inherited from class liquibase.ext.mongodb.statement.AbstractRunCommandStatement

command, COMMAND_NAME, OK, SHELL_DB_PREFIX, WRITE_ERRORS

Fields inherited from interface liquibase.statement.SqlStatement

EMPTY_SQL_STATEMENT

Constructor Summary

Constructors

Constructor	Description
FindOneAndUpdateStatement(String collectionName, org.bson.conversions.Bson filter, org.bson.conversions.Bson document, org.bson.conversions.Bson sort)
FindOneAndUpdateStatement(String collectionName, org.bson.Document options)

Method Summary

Modifier and Type	Method	Description
String	getRunCommandName()	Returns the RunCommand command name.
int	update(MongoLiquibaseDatabase database)	Executes the findAndModify operation

Methods inherited from class liquibase.ext.mongodb.statement.AbstractRunCommandStatement

checkResponse, execute, getCommandName, run, run, toJs

Methods inherited from class liquibase.nosql.statement.AbstractNoSqlStatement

continueOnError, skipOnUnsupported, toString

Methods inherited from class liquibase.statement.AbstractSqlStatement

setContinueOnError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RUN_COMMAND_NAME

public static final String RUN_COMMAND_NAME

See Also:

Constant Field Values

QUERY

public static final String QUERY

See Also:

Constant Field Values

UPDATE

public static final String UPDATE

See Also:

Constant Field Values

SORT

public static final String SORT

See Also:

Constant Field Values

VALUE

public static final String VALUE

See Also:

Constant Field Values

Constructor Detail

FindOneAndUpdateStatement

public FindOneAndUpdateStatement(String collectionName,
                                 org.bson.conversions.Bson filter,
                                 org.bson.conversions.Bson document,
                                 org.bson.conversions.Bson sort)

FindOneAndUpdateStatement

public FindOneAndUpdateStatement(String collectionName,
                                 org.bson.Document options)

Method Detail

getRunCommandName

public String getRunCommandName()

Description copied from class: AbstractRunCommandStatement

Returns the RunCommand command name.

Specified by:

getRunCommandName in class AbstractRunCommandStatement

Returns:

the run command as this is not used and not required for a generic RunCommandStatement

See Also:

Database Commands

update

public int update(MongoLiquibaseDatabase database)

Executes the findAndModify operation

Specified by:

update in interface NoSqlUpdateStatement<MongoLiquibaseDatabase>

Parameters:

database - the database to run against

Returns:

1 if a document was modified else 0