src/anonimongo/dbops/admmgmt

Search:
Group by:
Source   Edit  

Administration Commands

The actual APIs documentation can be referred to Mongo command documentation for better understanding of each API and its return value or BsonDocument. Any read commands will return either seq[BsonBase] or seq[BsonDocument] for fine tune handling query result.

For any write/update/modify/delete commands, it will usually return tuple of bool success and string reason or bool of success and int n of affected documents.

All APIs are async.

Procs

proc create(db: Database[AsyncSocket]; name: string;
            capsizemax = (false, 0, 0); storageEngine = bsonNull();
            validator = bsonNull(); validationLevel = "strict";
            validationAction = "error"; indexOptionDefaults = bsonNull();
            viewOn = ""; pipeline = bsonArray(); collation = bsonNull();
            writeConcern = bsonNull(); expireAfterSeconds = 0;
            timeseries = bsonNull()): Future[WriteResult] {....stackTrace: false,
    raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc create(db: Database[Socket]; name: string; capsizemax = (false, 0, 0);
            storageEngine = bsonNull(); validator = bsonNull();
            validationLevel = "strict"; validationAction = "error";
            indexOptionDefaults = bsonNull(); viewOn = "";
            pipeline = bsonArray(); collation = bsonNull();
            writeConcern = bsonNull(); expireAfterSeconds = 0;
            timeseries = bsonNull()): WriteResult {....raises: [ValueError,
    Exception, KeyError, MongoError, IOError, OSError, SnappyError, ZippyError,
    SslError, TimeoutError],
    tags: [RootEffect, WriteIOEffect, ReadIOEffect, TimeEffect], forbids: [].}
Source   Edit  
proc createIndexes(db: Database[AsyncSocket]; coll: string; indexes: BsonBase;
                   writeConcern = bsonNull(); commitQuorum = bsonNull();
                   comment = bsonNull()): Future[WriteResult] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc createIndexes(db: Database[Socket]; coll: string; indexes: BsonBase;
                   writeConcern = bsonNull(); commitQuorum = bsonNull();
                   comment = bsonNull()): WriteResult {....raises: [KeyError,
    ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit  
proc currentOp(db: Database[AsyncSocket]; opt = bson()): Future[BsonDocument] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc currentOp(db: Database[Socket]; opt = bson()): BsonDocument {....raises: [
    KeyError, ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit  
proc dropCollection(db: Database[AsyncSocket]; coll: string; wt = bsonNull();
                    comment = bsonNull()): Future[WriteResult] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc dropCollection(db: Database[Socket]; coll: string; wt = bsonNull();
                    comment = bsonNull()): WriteResult {....raises: [KeyError,
    ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit  
proc dropDatabase(db: Database[AsyncSocket]; wt = bsonNull();
                  comment = bsonNull()): Future[WriteResult] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc dropDatabase(db: Database[Socket]; wt = bsonNull(); comment = bsonNull()): WriteResult {....raises: [
    KeyError, ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit  
proc dropIndexes(db: Database[AsyncSocket]; coll: string; indexes: BsonBase;
                 wt = bsonNull(); comment = bsonNull()): Future[WriteResult] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc dropIndexes(db: Database[Socket]; coll: string; indexes: BsonBase;
                 wt = bsonNull(); comment = bsonNull()): WriteResult {....raises: [
    KeyError, ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit  
proc getDefaultReadConcern(db: Database[AsyncSocket]; inMemory = false;
                           comment = bsonNull()): Future[BsonDocument] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc getDefaultReadConcern(db: Database[Socket]; inMemory = false;
                           comment = bsonNull()): BsonDocument {....raises: [
    KeyError, ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit  
proc killCursors(db: Database[AsyncSocket]; collname: string;
                 cursorIds: seq[int64]): Future[BsonDocument] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc killCursors(db: Database[Socket]; collname: string; cursorIds: seq[int64]): BsonDocument {....raises: [
    KeyError, ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit  
proc killOp(db: Database[AsyncSocket]; opid: int32; comment = bsonNull()): Future[
    WriteResult] {....stackTrace: false, raises: [Exception, ValueError],
                   tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect],
                   forbids: [].}
Source   Edit  
proc killOp(db: Database[Socket]; opid: int32; comment = bsonNull()): WriteResult {....raises: [
    ValueError, Exception, KeyError, MongoError, IOError, OSError, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [RootEffect, WriteIOEffect, ReadIOEffect, TimeEffect], forbids: [].}
Source   Edit  
proc listCollectionNames(db: Database[AsyncSocket]; dbname = ""): Future[
    seq[string]] {....stackTrace: false, raises: [Exception, ValueError],
                   tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect],
                   forbids: [].}
Source   Edit  
proc listCollectionNames(db: Database[Socket]; dbname = ""): seq[string] {....raises: [
    ValueError, Exception, KeyError, MongoError, IOError, OSError, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [RootEffect, WriteIOEffect, ReadIOEffect, TimeEffect], forbids: [].}
Source   Edit  
proc listCollections(db: Database[AsyncSocket]; dbname = "";
                     filter = bsonNull(); nameonly = false;
                     authorizedCollections = false; comment = bsonNull()): Future[
    seq[BsonBase]] {....stackTrace: false, raises: [Exception, ValueError], tags: [
    RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc listCollections(db: Database[Socket]; dbname = ""; filter = bsonNull();
                     nameonly = false; authorizedCollections = false;
                     comment = bsonNull()): seq[BsonBase] {....raises: [ValueError,
    Exception, KeyError, MongoError, IOError, OSError, SnappyError, ZippyError,
    SslError, TimeoutError],
    tags: [RootEffect, WriteIOEffect, ReadIOEffect, TimeEffect], forbids: [].}
Source   Edit  
proc listDatabaseNames(db: Database[AsyncSocket]): Future[seq[string]] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc listDatabaseNames(db: Database[Socket]): seq[string] {....raises: [ValueError,
    Exception, KeyError, MongoError, IOError, OSError, SnappyError, ZippyError,
    SslError, TimeoutError],
    tags: [RootEffect, WriteIOEffect, ReadIOEffect, TimeEffect], forbids: [].}
Source   Edit  
proc listDatabases(db: Database[AsyncSocket]; filter = bsonNull();
                   nameonly = false; authorizedCollections = false;
                   comment = bsonNull()): Future[seq[BsonBase]] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc listDatabases(db: Database[Socket]; filter = bsonNull(); nameonly = false;
                   authorizedCollections = false; comment = bsonNull()): seq[
    BsonBase] {....raises: [ValueError, Exception, KeyError, MongoError, IOError,
                         OSError, SnappyError, ZippyError, SslError,
                         TimeoutError],
                tags: [RootEffect, WriteIOEffect, ReadIOEffect, TimeEffect],
                forbids: [].}
Source   Edit  
proc listIndexes(db: Database[AsyncSocket]; coll: string; comment = bsonNull()): Future[
    seq[BsonBase]] {....stackTrace: false, raises: [Exception, ValueError], tags: [
    RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc listIndexes(db: Database[Socket]; coll: string; comment = bsonNull()): seq[
    BsonBase] {....raises: [KeyError, ValueError, MongoError, IOError, OSError,
                         Exception, SnappyError, ZippyError, SslError,
                         TimeoutError],
                tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect],
                forbids: [].}
Source   Edit  
proc renameCollection(db: Database[AsyncSocket]; from, to: string;
                      wt = bsonNull(); comment = bsonNull()): Future[WriteResult] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc renameCollection(db: Database[Socket]; from, to: string; wt = bsonNull();
                      comment = bsonNull()): WriteResult {....raises: [ValueError,
    KeyError, MongoError, IOError, OSError, Exception, SnappyError, ZippyError,
    SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit  
proc setDefaultRWConcern(db: Database[AsyncSocket];
                         defaultReadConcern = bsonNull();
                         defaultWriteConcern = bsonNull(); wt = bsonNull();
                         comment = bsonNull()): Future[BsonDocument] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc setDefaultRWConcern(db: Database[Socket]; defaultReadConcern = bsonNull();
                         defaultWriteConcern = bsonNull(); wt = bsonNull();
                         comment = bsonNull()): BsonDocument {....raises: [
    ValueError, Exception, KeyError, MongoError, IOError, OSError, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [RootEffect, WriteIOEffect, ReadIOEffect, TimeEffect], forbids: [].}
Source   Edit  
proc shutdown(db: Database[AsyncSocket]; force = false; timeout = 10;
              comment = bsonNull()): Future[WriteResult] {....stackTrace: false,
    raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc shutdown(db: Database[Socket]; force = false; timeout = 10;
              comment = bsonNull()): WriteResult {....raises: [KeyError,
    ValueError, MongoError, TimeoutError, OSError, Exception, SnappyError,
    ZippyError, SslError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit  
proc shutdown(m: Mongo[AsyncSocket]; force = false; timeout = 10;
              comment = bsonNull()): Future[WriteResult] {....stackTrace: false,
    raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit  
proc shutdown(m: Mongo[Socket]; force = false; timeout = 10;
              comment = bsonNull()): WriteResult {....raises: [KeyError,
    ValueError, MongoError, TimeoutError, OSError, Exception, SnappyError,
    ZippyError, SslError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit