Zymba Documentation

SQL.Connection

Text

object @SQL.Connection(@Base) {
	begin(): $this {}
	close() {}
	commit(): $this {}
	countAffectedRows(): int {}
	countRowsInTable(string $table): int {}
	delete(string $table, object $conditions): int {}
	exists(string $table, object $conditions): bool {}
	exit() {}
	fetchAll(string $query, bool $indexed): object {}
	fetchAllOfField(string $query, int $index): object {}
	fetchOne(string $query, bool $indexed): object {}
	getCharset(): string {}
	getDatabaseName(): string {}
	getDatabaseSize(): int {}
	getLastInsertID(): int {}
	getVersion(): string {}
	insert(string $table, object $data): int {}
	listFieldsInTable(string $table): object {}
	listTables(): object {}
	query(string $query): object {}
	releaseSavepoint(string $name): $this {}
	rollback(): $this {}
	rollbackToSavepoint(string $name): $this {}
	savepoint(string $name): $this {}
	selectAll(string $table, object $fields, object $conditions, object $orderby, int $limit, int $offset, bool $indexed): object {}
	selectAllOfField(string $table, string $field, object $conditions, object $orderby, int $limit, int $offset): object {}
	selectOne(string $table, object $fields, object $conditions, object $orderby, bool $indexed): object {}
	selectSavepoint(string $name): object {}
	selectTransaction(): object {}
	setCharset(string $charset): $this {}
	update(string $table, object $data, object $conditions): int {}
	updateOrInsert(string $table, object $data, object $conditions): int {}
}

Abstract SQL connection prototype.

Prototype

Base

Methods

CODE

$this.begin(): this

Returns

Type	Value
$this

Closes this connection and frees its associated resources.

CODE

$this.close(): void

CODE

$this.commit(): this

Returns

Type	Value
$this

CODE

$this.countAffectedRows(): int

Returns

Type	Value
int

CODE

$this.countRowsInTable(string $table): int

Parameters

Name	Type	Value	Default
table	string		""

Returns

Type	Value
int

CODE

$this.delete(string $table, object $conditions): int

Parameters

Name	Type	Value	Default
table	string		""
conditions	object	[field: value, ...]	[]

Returns

Type	Value
int

CODE

$this.exists(string $table, object $conditions): bool

Parameters

Name	Type	Value	Default
table	string		""
conditions	object	[field: value, ...]	[]

Returns

Type	Value
bool

Closes this connection and frees its associated resources for the purpose of contextualization.

CODE

$this.exit(): void

CODE

$this.fetchAll(string $query, bool $indexed): object

Parameters

Name	Type	Value	Default
query	string		""
indexed	bool		false

Returns

Type	Value
object	[row, ...]

CODE

$this.fetchAllOfField(string $query, int $index): object

Parameters

Name	Type	Value	Default
query	string		""
index	int		0

Returns

Type	Value
object	[value, ...]

CODE

$this.fetchOne(string $query, bool $indexed): object

Parameters

Name	Type	Value	Default
query	string		""
indexed	bool		false

Returns

Type	Value
object	[field: value, ...]
null

CODE

$this.getCharset(): string

Returns

Type	Value
string

CODE

$this.getDatabaseName(): string

Returns

Type	Value
string

CODE

$this.getDatabaseSize(): int

Returns

Type	Value
int

CODE

$this.getLastInsertID(): int

Returns

Type	Value
int

CODE

$this.getVersion(): string

Returns

Type	Value
string

CODE

$this.insert(string $table, object $data): int

Parameters

Name	Type	Value	Default
table	string		""
data	object	[field: value, ...]	[]

Returns

Type	Value
int

CODE

$this.listFieldsInTable(string $table): object

Parameters

Name	Type	Value	Default
table	string		""

Returns

Type	Value
object	[field, ...]

CODE

$this.listTables(): object

Returns

Type	Value
object	[table, ...]

CODE

$this.query(string $query): object

Parameters

Name	Type	Value	Default
query	string		""

Returns

Type	Value
object	SQL.ResultSet
null

CODE

$this.releaseSavepoint(string $name): this

Parameters

Name	Type	Value	Default
name	string		""

Returns

Type	Value
$this

CODE

$this.rollback(): this

Returns

Type	Value
$this

CODE

$this.rollbackToSavepoint(string $name): this

Parameters

Name	Type	Value	Default
name	string		""

Returns

Type	Value
$this

CODE

$this.savepoint(string $name): this

Parameters

Name	Type	Value	Default
name	string		""

Returns

Type	Value
$this

CODE

$this.selectAll(string $table, object $fields, object $conditions, object $orderby, int $limit, int $offset, bool $indexed): object

Parameters

Name	Type	Value	Default
table	string		""
fields	object	[field, ...]	[]
conditions	object	[field: value, ...]	[]
orderby	object	[field: descending, ...]	[]
limit	int		0
offset	int		0
indexed	bool		false

Returns

Type	Value
object	[row, ...]

CODE

$this.selectAllOfField(string $table, string $field, object $conditions, object $orderby, int $limit, int $offset): object

Parameters

Name	Type	Value	Default
table	string		""
field	string		""
conditions	object	[field: value, ...]	[]
orderby	object	[field: descending, ...]	[]
limit	int		0
offset	int		0

Returns

Type	Value
object	[value, ...]

CODE

$this.selectOne(string $table, object $fields, object $conditions, object $orderby, bool $indexed): object

Parameters

Name	Type	Value	Default
table	string		""
fields	object	[field, ...]	[]
conditions	object	[field: value, ...]	[]
orderby	object	[field: descending, ...]	[]
indexed	bool		false

Returns

Type	Value
object	[field: value, ...]
null

CODE

$this.selectSavepoint(string $name): @SQL.SavepointContext

Parameters

Name	Type	Value	Default
name	string		""

Returns

Type	Value
@SQL.SavepointContext

CODE

$this.selectTransaction(): @SQL.TransactionContext

Returns

Type	Value
@SQL.TransactionContext

CODE

$this.setCharset(string $charset): this

Parameters

Name	Type	Value	Default
charset	string		""

Returns

Type	Value
$this

CODE

$this.update(string $table, object $data, object $conditions): int

Parameters

Name	Type	Value	Default
table	string		""
data	object	[field: value, ...]	[]
conditions	object	[field: value, ...]	[]

Returns

Type	Value
int

CODE

$this.updateOrInsert(string $table, object $data, object $conditions): int

Parameters

Name	Type	Value	Default
table	string		""
data	object	[field: value, ...]	[]
conditions	object	[field: value, ...]	[]

Returns

Type	Value
int