mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/ListCollectionNamesIterable

ListCollectionNamesIterable

class ListCollectionNamesIterable(wrapped: ListCollectionNamesIterable) : MongoIterable<String>

Iterable for listing collection names.

Since

5.0

See also

List collections

Constructors

ListCollectionNamesIterable

constructor(wrapped: ListCollectionNamesIterable)

Functions

authorizedCollections

fun authorizedCollections(authorizedCollections: Boolean): ListCollectionNamesIterable

Sets the authorizedCollections field of the listCollections command.

open override fun batchSize(batchSize: Int): ListCollectionNamesIterable

Sets the number of documents to return per batch.

fun comment(comment: String?): ListCollectionNamesIterable

fun comment(comment: BsonValue?): ListCollectionNamesIterable

Sets the comment for this operation. A null value means no comment is set.

open fun cursor(): MongoCursor<String>

Returns a cursor used for iterating over elements of type `T. The cursor is primarily used for change streams.

fun filter(filter: Bson?): ListCollectionNamesIterable

Sets the query filter to apply to the returned database names.

fun first(): String

fun firstOrNull(): String?

fun forEach(action: (String) -> Unit)

Performs the given action on each element and safely closes the cursor.

fun <R> map(transform: (String) -> R): MongoIterable<R>

Maps this iterable from the source document type to the target document type.

fun maxTime(maxTime: Long, timeUnit: TimeUnit = TimeUnit.MILLISECONDS): ListCollectionNamesIterable

Sets the maximum execution time on the server for this operation.

fun <C : MutableCollection<in String>> toCollection(destination: C): C

Appends all elements to the given destination collection.

fun toList(): List<String>

fun <R> use(consumer: (Sequence<String>) -> R): R

Creates a new cursor and treats it as a Sequence, invokes the given consumer function and closes the cursor down correctly whether an exception is thrown or not.