src/anonimongo/dbops/client

Search:
Group by:
Source   Edit  

Client module and User Management Commands

This APIs handling connection for Mongo and also implement user management APIs which can be referred here. These APIs are for write/update/modify and delete operations hence all of these return tuple of bool success together string reason or int n affected documents.

All APIs are async.

Consts

anonimongoVersion = "0.7.0"
Source   Edit  

Procs

proc connect(m: Mongo[AsyncSocket]): Future[bool] {....stackTrace: false,
    raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit   
proc connect(m: Mongo[Socket]): bool {....raises: [KeyError, ValueError,
    MongoError, IOError, OSError, Exception, SnappyError, ZippyError, SslError,
    TimeoutError], tags: [ReadIOEffect, RootEffect, WriteIOEffect, TimeEffect],
                                       forbids: [].}
Source   Edit   
proc createUser(db: Database[AsyncSocket]; user, pwd: string;
                roles = bsonArray(); restrictions = bsonArray();
                mechanism = bsonArray("SCRAM-SHA-256", "SCRAM-SHA-1");
                writeConcern = bsonNull(); customData = bsonNull()): Future[
    WriteResult] {....stackTrace: false, raises: [Exception, ValueError],
                   tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect],
                   forbids: [].}
Source   Edit   
proc createUser(db: Database[Socket]; user, pwd: string; roles = bsonArray();
                restrictions = bsonArray();
                mechanism = bsonArray("SCRAM-SHA-256", "SCRAM-SHA-1");
                writeConcern = bsonNull(); customData = bsonNull()): WriteResult {....raises: [
    KeyError, ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit   
proc dropAllUsersFromDatabase(db: Database[AsyncSocket]): Future[WriteResult] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit   
proc dropAllUsersFromDatabase(db: Database[Socket]): WriteResult {....raises: [
    KeyError, ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit   
proc dropUser(db: Database[AsyncSocket]; user: string): Future[WriteResult] {.
    ...stackTrace: false, raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit   
proc dropUser(db: Database[Socket]; user: string): WriteResult {....raises: [
    KeyError, ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit   
proc grantRolesToUser(db: Database[AsyncSocket]; user: string;
                      roles = bsonArray(); writeConcern = bsonNull()): Future[
    WriteResult] {....stackTrace: false, raises: [Exception, ValueError],
                   tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect],
                   forbids: [].}
Source   Edit   
proc grantRolesToUser(db: Database[Socket]; user: string; roles = bsonArray();
                      writeConcern = bsonNull()): WriteResult {....raises: [
    KeyError, ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit   
proc revokeRolesFromUser(db: Database[AsyncSocket]; user: string;
                         roles = bsonArray(); writeConcern = bsonNull()): Future[
    WriteResult] {....stackTrace: false, raises: [Exception, ValueError],
                   tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect],
                   forbids: [].}
Source   Edit   
proc revokeRolesFromUser(db: Database[Socket]; user: string;
                         roles = bsonArray(); writeConcern = bsonNull()): WriteResult {....raises: [
    KeyError, ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit   
proc updateUser(db: Database[AsyncSocket]; user, pwd: string;
                roles = bsonArray(); restrictions = bsonArray();
                mechanism = bsonArray("SCRAM-SHA-256", "SCRAM-SHA-1");
                writeConcern = bsonNull(); customData = bsonNull()): Future[
    WriteResult] {....stackTrace: false, raises: [Exception, ValueError],
                   tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect],
                   forbids: [].}
Source   Edit   
proc updateUser(db: Database[Socket]; user, pwd: string; roles = bsonArray();
                restrictions = bsonArray();
                mechanism = bsonArray("SCRAM-SHA-256", "SCRAM-SHA-1");
                writeConcern = bsonNull(); customData = bsonNull()): WriteResult {....raises: [
    KeyError, ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit   
proc usersInfo(db: Database[AsyncSocket]; usersInfo: BsonBase;
               showCredentials = false; showPrivileges = false;
               showAuthenticationRestictions = false; filters = bson();
               comment = bsonNull()): Future[BsonDocument] {....stackTrace: false,
    raises: [Exception, ValueError],
    tags: [RootEffect, TimeEffect, WriteIOEffect, ReadIOEffect], forbids: [].}
Source   Edit   
proc usersInfo(db: Database[Socket]; usersInfo: BsonBase;
               showCredentials = false; showPrivileges = false;
               showAuthenticationRestictions = false; filters = bson();
               comment = bsonNull()): BsonDocument {....raises: [KeyError,
    ValueError, MongoError, IOError, OSError, Exception, SnappyError,
    ZippyError, SslError, TimeoutError],
    tags: [WriteIOEffect, ReadIOEffect, RootEffect, TimeEffect], forbids: [].}
Source   Edit  

Made with Nim. Generated: 2023-10-04 14:15:48 UTC