Database.MongoDB.Admin

Database administrative functions

Admin

Collection

data CollectionOption

Constructors

Capped

MaxByteSize Int

MaxItems Int

Instances

Eq CollectionOption

Defined in Database.MongoDB.Admin

Methods

(==) :: CollectionOption -> CollectionOption -> Bool

(/=) :: CollectionOption -> CollectionOption -> Bool

Show CollectionOption

Defined in Database.MongoDB.Admin

Methods

showsPrec :: Int -> CollectionOption -> ShowS

show :: CollectionOption -> String

showList :: [CollectionOption] -> ShowS

createCollection :: MonadIO m => [CollectionOption] -> Collection -> Action m Document

Create collection with given options. You only need to call this to set options, otherwise a collection is created automatically on first use with no options.

renameCollection :: MonadIO m => Collection -> Collection -> Action m Document

Rename first collection to second collection

dropCollection :: (MonadIO m, MonadFail m) => Collection -> Action m Bool

Delete the given collection! Return True if collection existed (and was deleted); return False if collection did not exist (and no action).

validateCollection :: MonadIO m => Collection -> Action m Document

Validate the given collection, scanning the data and indexes for correctness. This operation takes a while.

Index

data Index

Constructors

Index

Fields

• iColl :: Collection
• iKey :: Order
• iName :: IndexName
• iUnique :: Bool
• iDropDups :: Bool
• iExpireAfterSeconds :: Maybe Int

Instances

Eq Index

Defined in Database.MongoDB.Admin

Methods

(==) :: Index -> Index -> Bool

(/=) :: Index -> Index -> Bool

Show Index

Defined in Database.MongoDB.Admin

Methods

showsPrec :: Int -> Index -> ShowS

show :: Index -> String

showList :: [Index] -> ShowS

type IndexName = Text

index :: Collection -> Order -> Index

Spec of index of ordered keys on collection. iName is generated from keys. iUnique and iDropDups are False.

ensureIndex :: MonadIO m => Index -> Action m ()

Create index if we did not already create one. May be called repeatedly with practically no performance hit, because we remember if we already called this for the same index (although this memory gets wiped out every 15 minutes, in case another client drops the index and we want to create it again).

createIndex :: MonadIO m => Index -> Action m ()

Create index on the server. This call goes to the server every time.

dropIndex :: MonadIO m => Collection -> IndexName -> Action m Document

Remove the index from the given collection.

getIndexes :: MonadIO m => Collection -> Action m [Document]

Get all indexes on this collection

dropIndexes :: MonadIO m => Collection -> Action m Document

Drop all indexes on this collection

User

allUsers :: MonadIO m => Action m [Document]

Fetch all users of this database

addUser :: MonadIO m => Bool -> Username -> Password -> Action m ()

Add user with password with read-only access if the boolean argument is True, or read-write access if it's False

removeUser :: MonadIO m => Username -> Action m ()

Database

admin :: Database

The "admin" database, which stores user authorization and authentication data plus other system collections.

cloneDatabase :: MonadIO m => Database -> Host -> Action m Document

Copy database from given host to the server I am connected to. Fails and returns "ok" = 0 if we don't have permission to read from given server (use copyDatabase in this case).

copyDatabase :: MonadIO m => Database -> Host -> Maybe (Username, Password) -> Database -> Action m Document

Copy database from given host to the server I am connected to. If username & password is supplied use them to read from given host.

dropDatabase :: MonadIO m => Database -> Action m Document

Delete the given database!

repairDatabase :: MonadIO m => Database -> Action m Document

Attempt to fix any corrupt records. This operation takes a while.

Server

serverBuildInfo :: MonadIO m => Action m Document

Return a document containing the parameters used to compile the server instance.

serverVersion :: MonadIO m => Action m Text

Return the version of the server instance.

Diagnotics

Collection

collectionStats :: MonadIO m => Collection -> Action m Document

Return some storage statistics for the given collection.

dataSize :: MonadIO m => Collection -> Action m Int

Return the total uncompressed size (in bytes) in memory of all records in the given collection. Does not include indexes.

storageSize :: MonadIO m => Collection -> Action m Int

Return the total bytes allocated to the given collection. Does not include indexes.

totalIndexSize :: MonadIO m => Collection -> Action m Int

The total size in bytes of all indexes in this collection.

totalSize :: MonadIO m => Collection -> Action m Int

Profiling

data ProfilingLevel

The available profiler levels.

Constructors

Off

No data collection.

Slow

Data collected only for slow operations. The slow operation time threshold is 100ms by default, but can be changed using setProfilingLevel.

All

Data collected for all operations.

Instances

Enum ProfilingLevel

Defined in Database.MongoDB.Admin

Methods

succ :: ProfilingLevel -> ProfilingLevel

pred :: ProfilingLevel -> ProfilingLevel

toEnum :: Int -> ProfilingLevel

fromEnum :: ProfilingLevel -> Int

enumFrom :: ProfilingLevel -> [ProfilingLevel]

enumFromThen :: ProfilingLevel -> ProfilingLevel -> [ProfilingLevel]

enumFromTo :: ProfilingLevel -> ProfilingLevel -> [ProfilingLevel]

enumFromThenTo :: ProfilingLevel -> ProfilingLevel -> ProfilingLevel -> [ProfilingLevel]

Eq ProfilingLevel

Defined in Database.MongoDB.Admin

Methods

(==) :: ProfilingLevel -> ProfilingLevel -> Bool

(/=) :: ProfilingLevel -> ProfilingLevel -> Bool

Show ProfilingLevel

Defined in Database.MongoDB.Admin

Methods

showsPrec :: Int -> ProfilingLevel -> ShowS

show :: ProfilingLevel -> String

showList :: [ProfilingLevel] -> ShowS

getProfilingLevel :: MonadIO m => Action m ProfilingLevel

Get the profiler level.

type MilliSec = Int

setProfilingLevel :: MonadIO m => ProfilingLevel -> Maybe MilliSec -> Action m ()

Set the profiler level, and optionally the slow operation time threshold (in milliseconds).

Database

dbStats :: MonadIO m => Action m Document

Return some storage statistics for the given database.

type OpNum = Int

An operation indentifier.

currentOp :: MonadIO m => Action m (Maybe Document)

See currently running operation on the database, if any

killOp :: MonadIO m => OpNum -> Action m (Maybe Document)

Terminate the operation specified by the given OpNum.

Server

serverStatus :: MonadIO m => Action m Document

Return a document with an overview of the state of the database.