Skip to content

Latest commit

 

History

History
494 lines (182 loc) · 4.53 KB

MongoLite.md

File metadata and controls

494 lines (182 loc) · 4.53 KB
Raw

MongoLite

  • Full name: \MongoHybrid\MongoLite

Properties

client

protected \MongoLite\Client $client

Methods

__construct

public __construct(string $server, array $options = []): mixed

Parameters:

Parameter Type Description
$server string
$options array

lstCollections

public lstCollections(): array

getCollection

public getCollection(string $name, ?string $db = null): \MongoLite\Collection

Parameters:

Parameter Type Description
$name string
$db ?string

dropCollection

public dropCollection(string $name, ?string $db = null): mixed

Parameters:

Parameter Type Description
$name string
$db ?string

renameCollection

public renameCollection(string $name, string $newname, ?string $db = null): bool

Parameters:

Parameter Type Description
$name string
$newname string
$db ?string

findOne

public findOne(string $collection, ?array $filter = null, ?array $projection = null): ?array

Parameters:

Parameter Type Description
$collection string
$filter ?array
$projection ?array

findOneById

public findOneById(string $collection, string $id): ?array

Parameters:

Parameter Type Description
$collection string
$id string

find

public find(string $collection, array $options = []): \MongoHybrid\ResultSet

Parameters:

Parameter Type Description
$collection string
$options array

aggregate

public aggregate(string $collection, array $pipeline): mixed

Parameters:

Parameter Type Description
$collection string
$pipeline array

getFindTermFilter

public getFindTermFilter(mixed $term): mixed

Parameters:

Parameter Type Description
$term mixed

insert

public insert(string $collection, array& $doc): mixed

Parameters:

Parameter Type Description
$collection string
$doc array

save

public save(string $collection, array& $data, bool $create = false): mixed

Parameters:

Parameter Type Description
$collection string
$data array
$create bool

update

public update(string $collection, mixed $criteria, array $data): mixed

Parameters:

Parameter Type Description
$collection string
$criteria mixed
$data array

remove

public remove(string $collection, array $filter = []): mixed

Parameters:

Parameter Type Description
$collection string
$filter array

removeField

public removeField(string $collection, string $field, array $filter = []): bool

Parameters:

Parameter Type Description
$collection string
$field string
$filter array

renameField

public renameField(string $collection, string $field, string $newfield, array $filter = []): bool

Parameters:

Parameter Type Description
$collection string
$field string
$newfield string
$filter array

count

public count(string $collection, mixed $filter = null): int

Parameters:

Parameter Type Description
$collection string
$filter mixed