MongoCollection クラス

(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 integer $w ;

public integer $wtimeout ;

/* メソッド */

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

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

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

public __construct ( MongoDB $db , string $name )

public int count ([ array $query = array() [, int $limit = 0 [, int $skip = 0 ]]] )

public array createDBRef ( mixed $document_or_id )

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

public array deleteIndex ( string|array $keys )

public array deleteIndexes ( void )

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

public array drop ( void )

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

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

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

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

public MongoCollection __get ( string $name )

public array getDBRef ( array $ref )

public array getIndexInfo ( void )

public string getName ( void )

public array getReadPreference ( void )

public bool getSlaveOkay ( void )

public array getWriteConcern ( void )

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

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

public array[MongoCommandCursor] parallelCollectionScan ( int $num_cursors )

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

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

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

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

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

static protected string toIndexString ( mixed $keys )

public string __toString ( void )

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

public array validate ([ bool $scan_data = FALSE ] )

}

定義済み定数

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

フィールド

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

参考

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

MongoCollection::aggregate — aggregation フレームワークを使って集約する
MongoCollection::aggregateCursor — Execute an aggregation pipeline command and retrieve results through a cursor
MongoCollection::batchInsert — 複数のドキュメントをコレクションに追加する
MongoCollection::__construct — 新しいコレクションを作成する
MongoCollection::count — コレクション内のドキュメント数を数える
MongoCollection::createDBRef — データベースへの参照を作成する
MongoCollection::createIndex — Creates an index on the specified field(s) if it does not already exist.
MongoCollection::deleteIndex — コレクションからインデックスを削除する
MongoCollection::deleteIndexes — コレクションのすべてのインデックスを削除する
MongoCollection::distinct — コレクション内で、指定したキーに対応する区別できる値の一覧を取得する
MongoCollection::drop — コレクションを削除する
MongoCollection::ensureIndex — 指定したフィールドが存在しない場合にインデックスを作成する
MongoCollection::find — コレクションに問い合わせ、結果セットの MongoCursor を返す
MongoCollection::findAndModify — ドキュメントを更新して返す
MongoCollection::findOne — コレクションに問い合わせ、単一の要素を返す
MongoCollection::__get — コレクションを取得する
MongoCollection::getDBRef — データベース参照が指すドキュメントを取得する
MongoCollection::getIndexInfo — このコレクションのインデックスについての情報を返す
MongoCollection::getName — コレクションの名前を返す
MongoCollection::getReadPreference — このコレクションの優先読み込みを取得する
MongoCollection::getSlaveOkay — このコレクションの slaveOkay 設定を取得する
MongoCollection::getWriteConcern — Get the write concern for this collection
MongoCollection::group — SQL の GROUP BY コマンドと似た処理を行う
MongoCollection::insert — ドキュメントをコレクションに追加する
MongoCollection::parallelCollectionScan — Returns an array of cursors to iterator over a full collection in parallel
MongoCollection::remove — レコードをコレクションから削除する
MongoCollection::save — ドキュメントをコレクションに保存する
MongoCollection::setReadPreference — このコレクションの優先読み込みを設定する
MongoCollection::setSlaveOkay — このコレクションの slaveOkay の設定を変更する
MongoCollection::setWriteConcern — Set the write concern for this database
MongoCollection::toIndexString — インデックスを指定するキーを、インデックスを指す文字列に変換する
MongoCollection::__toString — このコレクションの文字列表現
MongoCollection::update — 指定した条件にもとづいてレコードを更新する
MongoCollection::validate — コレクションを検証する

MongoCollection クラス

導入

クラス概要

定義済み定数

フィールド

参考

目次