Package liquibase.ext.mongodb.statement

Class ListCollectionNamesStatement

java.lang.Object

liquibase.statement.AbstractSqlStatement

liquibase.nosql.statement.AbstractNoSqlStatement

liquibase.ext.mongodb.statement.AbstractMongoStatement

liquibase.ext.mongodb.statement.AbstractRunCommandStatement

liquibase.ext.mongodb.statement.ListCollectionNamesStatement

All Implemented Interfaces:

NoSqlExecuteStatement<MongoLiquibaseDatabase>, NoSqlQueryForListStatement<MongoLiquibaseDatabase,String>, liquibase.statement.SqlStatement

Direct Known Subclasses:

CountCollectionByNameStatement

public class ListCollectionNamesStatement
extends AbstractRunCommandStatement
implements NoSqlQueryForListStatement<MongoLiquibaseDatabase,String>

Gets a list of collection names via the database runCommand method For a list of supported options see the reference page:

See Also:

listCollections

Field Summary

Fields

Modifier and Type	Field	Description
static String	AUTHORIZED_COLLECTIONS
static String	CURSOR
static String	FILTER
static String	FIRST_BATCH
static String	NAME
static String	NAME_ONLY

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

command, COMMAND_NAME, OK, SHELL_DB_PREFIX, WRITE_ERRORS

Constructor Summary

Constructors

Constructor	Description
ListCollectionNamesStatement()	Create a listCollections statement with no filter.
ListCollectionNamesStatement(org.bson.Document filter)	Create a listCollections statement with the supplied filter.

Method Summary

Modifier and Type	Method	Description
String	getRunCommandName()	Returns the RunCommand command name.
List<String>	queryForList(MongoLiquibaseDatabase database)

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

FILTER

public static final String FILTER

See Also:

Constant Field Values

CURSOR

public static final String CURSOR

See Also:

Constant Field Values

FIRST_BATCH

public static final String FIRST_BATCH

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

AUTHORIZED_COLLECTIONS

public static final String AUTHORIZED_COLLECTIONS

See Also:

Constant Field Values

NAME_ONLY

public static final String NAME_ONLY

See Also:

Constant Field Values

Constructor Detail

ListCollectionNamesStatement

public ListCollectionNamesStatement()

Create a listCollections statement with no filter. i.e to return all collection names

ListCollectionNamesStatement

public ListCollectionNamesStatement(org.bson.Document filter)

Create a listCollections statement with the supplied filter.

Parameters:

filter - the filter to apply

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

queryForList

public List<String> queryForList(MongoLiquibaseDatabase database)

Specified by:

queryForList in interface NoSqlQueryForListStatement<MongoLiquibaseDatabase,String>