Php/docs/class.mongocollection

提供:Dev Guides
< Php
移動先:案内検索

(PECL mongo >=0.9.0)

はじめに

MongoDB のコレクションを表します。

コレクション名は ASCII セット内の任意の文字を使用できます。たとえば ""、"..."、"my collection" そして "*&#@" といった名前をつけることができます。

ユーザー定義のコレクション名には $ 記号を含めることができません。システムコレクションの中には $ を名前に使うものがあります (local.oplog.$main など) が、 これは予約文字です。名前に $ を含むコレクションを作ったり使ったりしようとすると、 MongoDB が assert を出します。


クラス概要


MongoCollection {

/* 定数 */

const int ASCENDING = 1

const int DESCENDING = -1

/* フィールド */

public MongoDB $db = null

public int $w

public int $wtimeout

/* メソッド */

public aggregate ( array $pipeline [, array $options ] ) : array

public aggregateCursor ( array $command [, array $options ] ) : MongoCommandCursor

public batchInsert ( array $a [, array $options = array() ] ) : mixed

public __construct ( MongoDB $db , string $name )

public count ([ array $query = array() [, array $options = array() ]] ) : int

public createDBRef ( mixed $document_or_id ) : array

public createIndex ( array $keys [, array $options = array() ] ) : bool

public deleteIndex ( string|array $keys ) : array

public deleteIndexes ( ) : array

public distinct ( string $key [, array $query ] ) : array|false

public drop ( ) : array

public ensureIndex ( string|array $key|keys [, array $options = array() ] ) : bool

public find ([ array $query = array() [, array $fields = array() ]] ) : MongoCursor

public findAndModify ( array $query [, array $update [, array $fields [, array $options ]]] ) : array

public findOne ([ array $query = array() [, array $fields = array() [, array $options = array() ]]] ) : array

public __get ( string $name ) : MongoCollection

public getDBRef ( array $ref ) : array

public getIndexInfo ( ) : array

public getName ( ) : string

public getReadPreference ( ) : array

public getSlaveOkay ( ) : bool

public getWriteConcern ( ) : array

public group ( mixed $keys , array $initial , MongoCode $reduce [, array $options = array() ] ) : array

public insert ( array|object $document [, array $options = array() ] ) : bool|array

public parallelCollectionScan ( int $num_cursors ) : array[MongoCommandCursor]

public remove ([ array $criteria = array() [, array $options = array() ]] ) : bool|array

public save ( array|object $document [, array $options = array() ] ) : mixed

public setReadPreference ( string $read_preference [, array $tags ] ) : bool

public setSlaveOkay ([ bool $ok = true ] ) : bool

public setWriteConcern ( mixed $w [, int $wtimeout ] ) : bool

static protected toIndexString ( mixed $keys ) : string

public __toString ( ) : string

public update ( array $criteria , array $new_object [, array $options = array() ] ) : bool|array

public validate ([ bool $scan_data = false ] ) : array

}

定義済み定数

MongoCollection::ASCENDING
ソートやインデックス作成時に使用する「昇順」。
MongoCollection::DESCENDING
ソートやインデックス作成時に使用する「降順」。


フィールド

db
このコレクションの "親" データベース。
w
成功を返す前に変更をレプリケートするサーバーの数。 この値は親データベースから引き継ぎます。 MongoDB クラスのマニュアルに、 w の挙動についてのより詳細な説明があります。
wtimeout
$this->w のレプリケーションが完了するまでに待つミリ秒数。 この値は親データベースから引き継ぎます。 MongoDB クラスのマニュアルに、 wtimeout の挙動についてのより詳細な説明があります。


参考

MongoDB コアドキュメントの » コレクション を参照ください。


目次