com.mongodb.operation

Class CreateViewOperation

java.lang.Object

com.mongodb.operation.CreateViewOperation

All Implemented Interfaces:

AsyncWriteOperation<Void>, WriteOperation<Void>

public class CreateViewOperation
extends Object
implements AsyncWriteOperation<Void>, WriteOperation<Void>

An operation to create a view.

Since:

3.4

MongoDB documentation

Create

Since server release

3.4

Constructor Summary

Constructors

Constructor and Description
CreateViewOperation(String databaseName, String viewName, String viewOn, List<BsonDocument> pipeline, WriteConcern writeConcern) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
CreateViewOperation	collation(Collation collation) Sets the default collation for the view.
Void	execute(WriteBinding binding) General execute which can return anything of type T
void	executeAsync(AsyncWriteBinding binding, SingleResultCallback<Void> callback) General execute which can return anything of type T
Collation	getCollation() Gets the default collation for the view
String	getDatabaseName() Gets the database name
List<BsonDocument>	getPipeline() Gets the pipeline that defines the view.
String	getViewName() Gets the name of the view to create.
String	getViewOn() Gets the name of the collection or view that backs this view.
WriteConcern	getWriteConcern() Gets the write concern.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateViewOperation

public CreateViewOperation(String databaseName,
                           String viewName,
                           String viewOn,
                           List<BsonDocument> pipeline,
                           WriteConcern writeConcern)

Construct a new instance.

Parameters:

databaseName - the name of the database for the operation, which may not be null

viewName - the name of the collection to be created, which may not be null

viewOn - the name of the collection or view that backs this view, which may not be null

pipeline - the aggregation pipeline that defines the view, which may not be null

writeConcern - the write concern, which may not be null

Method Detail

getDatabaseName

public String getDatabaseName()

Gets the database name

Returns:

the database name

getViewName

public String getViewName()

Gets the name of the view to create.

Returns:

the view name

getViewOn

public String getViewOn()

Gets the name of the collection or view that backs this view.

Returns:

the name of the collection or view that backs this view

getPipeline

public List<BsonDocument> getPipeline()

Gets the pipeline that defines the view.

Returns:

the pipeline that defines the view

getWriteConcern

public WriteConcern getWriteConcern()

Gets the write concern.

Returns:

the write concern

getCollation

public Collation getCollation()

Gets the default collation for the view

Returns:

the collation, which may be null

collation

public CreateViewOperation collation(Collation collation)

Sets the default collation for the view.

Parameters:

collation - the collation, which may be null

Returns:

this

execute

public Void execute(WriteBinding binding)

Description copied from interface: WriteOperation

General execute which can return anything of type T

Specified by:

execute in interface WriteOperation<Void>

Parameters:

binding - the binding to execute in the context of

Returns:

T, the result of the execution

executeAsync

public void executeAsync(AsyncWriteBinding binding,
                         SingleResultCallback<Void> callback)

Description copied from interface: AsyncWriteOperation

General execute which can return anything of type T

Specified by:

executeAsync in interface AsyncWriteOperation<Void>

Parameters:

binding - the binding to execute in the context of

callback - the callback to be called when the operation has been executed