---

Collection

• Full name: \Qubus\NoSql\Collection

Constants

Constant	Visibility	Type	Value
KEY_ID	public		'_id'
KEY_OLD_ID	public		'_old'
UPDATING	public		'updating'
UPDATED	public		'updated'
INSERTING	public		'inserting'
INSERTED	public		'inserted'
DELETING	public		'deleting'
DELETED	public		'deleted'
CHANGED	public		'changed'

Properties

filepath

protected ?string $filepath

---

resolver

protected mixed $resolver

---

events

protected array $events

---

transactionMode

protected bool $transactionMode

---

transactionData

protected array|null $transactionData

---

macros

protected array $macros

---

lastInsertId

protected ?string $lastInsertId

---

options

private array|bool[]|int[]|string[] $options

---

Methods

__construct

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

Parameters:

Parameter	Type	Description
$filepath	string
$options	array

---

macro

public macro(string $name, callable $callback): void

Parameters:

Parameter	Type	Description
$name	string	Macro name.
$callback	callable

---

hasMacro

Check if macro exists.

public hasMacro(string $name): bool

Parameters:

Parameter	Type	Description
$name	string	Macro name.

---

getMacro

Return macro.

public getMacro(string $name): mixed

Parameters:

Parameter	Type	Description
$name	string

---

getKeyId

public getKeyId(): string

---

getKeyOldId

public getKeyOldId(): string

---

isModeTransaction

public isModeTransaction(): bool

---

begin

public begin(): void

---

commit

public commit(): bool|int

---

rollback

public rollback(): void

---

transaction

public transaction(callable $callback, mixed $that = null, mixed $default = null): mixed

Parameters:

Parameter	Type	Description
$callback	callable
$that	mixed
$default	mixed

Throws:

• Exception

---

truncate

public truncate(): bool|int

---

on

public on(string $event, callable $callback): void

Parameters:

Parameter	Type	Description
$event	string	Event name.
$callback	callable

---

trigger

protected trigger(string $event, array& $args): void

Parameters:

Parameter	Type	Description
$event	string	Event name.
$args	array

---

loadData

public loadData(): mixed

Throws:

• InvalidJsonException

---

setResolver

public setResolver(callable $resolver): void

Parameters:

Parameter	Type	Description
$resolver	callable

---

getResolver

public getResolver(): mixed

---

query

public query(): \Qubus\NoSql\Query

---

where

public where(mixed $key): mixed

Parameters:

Parameter	Type	Description
$key	mixed

---

filter

public filter(\Closure $closure): mixed

Parameters:

Parameter	Type	Description
$closure	\Closure

---

map

public map(\Closure $mapper): \Qubus\NoSql\Query

Parameters:

Parameter	Type	Description
$mapper	\Closure

---

sortBy

public sortBy(string $key, string $asc = 'asc'): \Qubus\NoSql\Query

Parameters:

Parameter	Type	Description
$key	string
$asc	string

Throws:

• TypeException

---

sort

public sort(\Closure $value): mixed

Parameters:

Parameter	Type	Description
$value	\Closure

---

skip

public skip(int $offset): \Qubus\NoSql\Query

Parameters:

Parameter	Type	Description
$offset	int

---

take

public take(int $limit, int $offset): \Qubus\NoSql\Query

Parameters:

Parameter	Type	Description
$limit	int
$offset	int

---

all

public all(): array

Throws:

• InvalidJsonException

---

find

public find(mixed $id): mixed

Parameters:

Parameter	Type	Description
$id	mixed

Throws:

• InvalidJsonException

---

lists

public lists(mixed $key, mixed $resultKey = null): array

Parameters:

Parameter	Type	Description
$key	mixed
$resultKey	mixed

---

sum

public sum(mixed $key): mixed

Parameters:

Parameter	Type	Description
$key	mixed

---

count

public count(): ?int

---

avg

public avg(mixed $key): float|int

Parameters:

Parameter	Type	Description
$key	mixed

---

min

public min(mixed $key): mixed

Parameters:

Parameter	Type	Description
$key	mixed

---

max

public max(mixed $key): mixed

Parameters:

Parameter	Type	Description
$key	mixed

---

insert

public insert(array $data): array|bool|int|null

Parameters:

Parameter	Type	Description
$data	array

Throws:

• TypeException

• InvalidJsonException

---

inserts

public inserts(array $listData): bool|int

Parameters:

Parameter	Type	Description
$listData	array

Throws:

• TypeException

• InvalidJsonException

---

update

public update(array $data): array|bool|int|null

Parameters:

Parameter	Type	Description
$data	array

Throws:

• InvalidJsonException

• TypeException

---

delete

public delete(): array|bool|int|null

Throws:

• InvalidJsonException

• TypeException

---

withOne

1:1 relation.

public withOne(\Qubus\NoSql\Collection|\Qubus\NoSql\Query $relation, string $as, string $otherKey, string $operator = '=', ?string $thisKey = null): \Qubus\NoSql\Query

Parameters:

Parameter	Type	Description
$relation	\Qubus\NoSql\Collection|\Qubus\NoSql\Query
$as	string
$otherKey	string
$operator	string
$thisKey	?string

Throws:

• TypeException

---

withMany

1:n relation.

public withMany(\Qubus\NoSql\Collection|\Qubus\NoSql\Query $relation, string $as, string $otherKey, string $operator = '=', ?string $thisKey = null): \Qubus\NoSql\Query

Parameters:

Parameter	Type	Description
$relation	\Qubus\NoSql\Collection|\Qubus\NoSql\Query
$as	string
$otherKey	string
$operator	string
$thisKey	?string

Throws:

• TypeException

---

generateKey

public generateKey(): string

---

execute

public execute(\Qubus\NoSql\Query $query, string $type, array $arg = []): mixed

Parameters:

Parameter	Type	Description
$query	\Qubus\NoSql\Query
$type	string
$arg	array

Throws:

• TypeException

• InvalidJsonException

---

executePipes

protected executePipes(array $pipes): mixed

Parameters:

Parameter	Type	Description
$pipes	array

Throws:

• InvalidJsonException

---

executeInsert

protected executeInsert(\Qubus\NoSql\Query $query, array $new = []): ?array

Parameters:

Parameter	Type	Description
$query	\Qubus\NoSql\Query
$new	array

Throws:

• InvalidJsonException

• TypeException

---

executeUpdate

protected executeUpdate(\Qubus\NoSql\Query $query, array $new = []): bool|int|null

Parameters:

Parameter	Type	Description
$query	\Qubus\NoSql\Query
$new	array

Throws:

• InvalidJsonException

---

executeDelete

protected executeDelete(\Qubus\NoSql\Query $query): bool|int|null

Parameters:

Parameter	Type	Description
$query	\Qubus\NoSql\Query

Throws:

• InvalidJsonException

---

executeGet

protected executeGet(\Qubus\NoSql\Query $query): mixed

Parameters:

Parameter	Type	Description
$query	\Qubus\NoSql\Query

Throws:

• InvalidJsonException

---

executeSave

protected executeSave(\Qubus\NoSql\Query $query): ?int

Parameters:

Parameter	Type	Description
$query	\Qubus\NoSql\Query

Throws:

• InvalidJsonException

---

persists

public persists(array $data): bool|int

Parameters:

Parameter	Type	Description
$data	array

---

save

protected save(array $data): bool|int

Parameters:

Parameter	Type	Description
$data	array

---

lastInsertId

Returns the last insert id from the current document being acted upon.

public lastInsertId(): ?string

Return Value:

The last insert id.

---

__call

public __call(mixed $method, mixed $args): mixed

Parameters:

Parameter	Type	Description
$method	mixed
$args	mixed

Throws:

• UndefinedMethodException

---

---

Automatically generated on 2025-10-13

2025-10-132025-10-13