Maslosoft Mangan API

Name: Mangan
Brand: Maslosoft

Class Command

Command

Maslosoft\Mangan\Command uses Maslosoft\Mangan\Traits\AvailableCommands

Direct known subclasses

Maslosoft\Mangan\Helpers\CommandProxy

Namespace: Maslosoft\Mangan
Author: Piotr Maselkowski
Located at Command.php

Methods summary

`public`	# `__construct( Maslosoft\Addendum\Interfaces\AnnotatedInterface $model = null, Maslosoft\Mangan\Mangan $mangan = null )`
`public`	# `call( $command, $arguments = [] )`
`public`	# `__call( $name, $arguments )`
`public array`	# `create( string $collectionName, array $params = [] )` Explicitly creates a collection or view. Explicitly creates a collection or view. Parameter `$params` depends on MongoDB version, see (official documentation)[https://docs.mongodb.com/manual/reference/command/create/] for details Parameters `$collectionName` The name of the new collection `$params` Returns array
`public`	# `createUser( Maslosoft\Mangan\Model\Command\User $user, $writeConcerns = [] )`
`public`	# `dropUser( $username, $writeConcerns = [] )`
`public`	# `createIndex( $keys, $options = [] )`
`public array`	# `getIndexes( )` NOTE: This is broken NOTE: This is broken Returns array Throws `Maslosoft\Mangan\Exceptions\ManganException`
`public array`	# `collStats( string $collectionName, integer $scale = 1, boolean $verbose = false )` The `collStats` command returns a variety of storage statistics for a given collection. The `collStats` command returns a variety of storage statistics for a given collection. Parameters `$collectionName` The name of the target collection. If the collection does not exist, collStats returns an error message. `$scale` Optional. The scale used in the output to display the sizes of items. By default, output displays sizes in bytes. To display kilobytes rather than bytes, specify a scale value of 1024. The scale factor rounds values to whole numbers. `$verbose` Optional. When true, collStats increases reporting for the MMAPv1 Storage Engine. Defaults to false. Returns array

Methods used from Maslosoft\Mangan\Traits\AvailableCommands

_isSelf(), aggregate(), applyOps(), authenticate(), availableQueryOptions(), buildInfo(), checkShardingIndex(), cloneCollection(), cloneCollectionAsCapped(), cloneDb(), collMod(), compact(), connPoolStats(), connPoolSync(), connectionStatus(), convertToCapped(), count(), createIndexes(), createRole(), currentOpCtx(), dataSize(), dbHash(), dbStats(), delete(), distinct(), driverOIDTest(), drop(), dropAllRolesFromDatabase(), dropAllUsersFromDatabase(), dropDatabase(), dropIndexes(), dropRole(), evalJs(), explain(), features(), filemd5(), find(), findAndModify(), forceerror(), geoNear(), geoSearch(), getLastError(), getMore(), getPrevError(), getnonce(), grantPrivilegesToRole(), grantRolesToRole(), grantRolesToUser(), group(), handshake(), hostInfo(), insert(), isMaster(), killCursors(), listCollections(), listCommands(), listIndexes(), logout(), mapReduce(), mapReduceShardedFinish(), parallelCollectionScan(), ping(), planCacheClear(), planCacheClearFilters(), planCacheListFilters(), planCacheListPlans(), planCacheListQueryShapes(), planCacheSetFilter(), profile(), reIndex(), repairCursor(), repairDatabase(), resetError(), revokePrivilegesFromRole(), revokeRolesFromRole(), revokeRolesFromUser(), rolesInfo(), saslContinue(), saslStart(), serverStatus(), shardConnPoolStats(), splitVector(), touch(), update(), updateRole(), updateUser(), usersInfo(), validate(), whatsmyuri()

API documentation generated by ApiGen

Maslosoft Mangan API

Namespaces

Classes

Class Command

Direct known subclasses

Methods summary

Parameters

Returns

Returns

Throws

Parameters

Returns

Methods used from Maslosoft\Mangan\Traits\AvailableCommands

Contact us