Class to drive a PostgreSQL database for Dolibarr. More...

Inheritance diagram for DoliDBPgsql:

Collaboration diagram for DoliDBPgsql:

[legend]

Public Member Functions
	__construct ($type, $host, $user, $pass, $name='', $port=0)
	Constructor. More...

	convertSQLFromMysql ($line, $type='auto', $unescapeslashquot=false)
	Convert a SQL request in Mysql syntax to native syntax. More...

	select_db ($database)
	Select a database PostgreSQL does not have an equivalent for `mysql_select_db` Only compare if the chosen DB is the one active on the connection. More...

	connect ($host, $login, $passwd, $name, $port=0)
	Connection to server. More...

	getVersion ()
	Return version of database server. More...

	getDriverInfo ()
	Return version of database client driver. More...

	close ()
	Close database connection. More...

	query ($query, $usesavepoint=0, $type='auto', $result_mode=0)
	Convert request to PostgreSQL syntax, execute it and return the resultset. More...

	fetch_object ($resultset)
	Returns the current line (as an object) for the resultset cursor. More...

	fetch_array ($resultset)
	Return datas as an array. More...

	fetch_row ($resultset)
	Return datas as an array. More...

	num_rows ($resultset)
	Return number of lines for result of a SELECT. More...

	affected_rows ($resultset)
	Return the number of lines in the result of a request INSERT, DELETE or UPDATE. More...

	free ($resultset=null)
	Libere le dernier resultset utilise sur cette connection. More...

	plimit ($limit=0, $offset=0)
	Define limits and offset of request. More...

	escape ($stringtoencode)
	Escape a string to insert data. More...

	escapeforlike ($stringtoencode)
	Escape a string to insert data into a like. More...

	ifsql ($test, $resok, $resko)
	Format a SQL IF. More...

	regexpsql ($subject, $pattern, $sqlstring=0)
	Format a SQL REGEXP. More...

	errno ()
	Renvoie le code erreur generique de l'operation precedente. More...

	error ()
	Renvoie le texte de l'erreur pgsql de l'operation precedente. More...

	last_insert_id ($tab, $fieldid='rowid')
	Get last ID after an insert INSERT. More...

	encrypt ($fieldorvalue, $withQuotes=1)
	Encrypt sensitive data in database Warning: This function includes the escape and add the SQL simple quotes on strings. More...

	decrypt ($value)
	Decrypt sensitive data in database. More...

	DDLGetConnectId ()
	Return connection ID. More...

	DDLCreateDb ($database, $charset='', $collation='', $owner='')
	Create a new database Do not use function xxx_create_db (xxx=mysql, ...) as they are deprecated We force to create database with charset this->forcecharset and collate this->forcecollate. More...

	DDLListTables ($database, $table='')
	List tables into a database. More...

	DDLListTablesFull ($database, $table='')
	List tables into a database. More...

	DDLInfoTable ($table)
	List information of columns into a table. More...

	DDLCreateTable ($table, $fields, $primary_key, $type, $unique_keys=null, $fulltext_keys=null, $keys=null)
	Create a table into database. More...

	DDLDropTable ($table)
	Drop a table into database. More...

	DDLDescTable ($table, $field="")
	Return a pointer of line with description of a table or field. More...

	DDLAddField ($table, $field_name, $field_desc, $field_position="")
	Create a new field into table. More...

	DDLUpdateField ($table, $field_name, $field_desc)
	Update format of a field into a table. More...

	DDLDropField ($table, $field_name)
	Drop a field from table. More...

	DDLCreateUser ($dolibarr_main_db_host, $dolibarr_main_db_user, $dolibarr_main_db_pass, $dolibarr_main_db_name)
	Create a user to connect to database. More...

	getDefaultCharacterSetDatabase ()
	Return charset used to store data in database. More...

	getListOfCharacterSet ()
	Return list of available charset that can be used to store data in database. More...

	getDefaultCollationDatabase ()
	Return collation used in database. More...

	getListOfCollation ()
	Return list of available collation that can be used for database. More...

	getPathOfDump ()
	Return full path of dump program. More...

	getPathOfRestore ()
	Return full path of restore program. More...

	getServerParametersValues ($filter='')
	Return value of server parameters. More...

	getServerStatusValues ($filter='')
	Return value of server status. More...

Public Member Functions inherited from DoliDB
	prefix ()
	Return the DB prefix found into prefix_db (if it was set manually by doing $dbhandler->prefix_db=...). More...

	stddevpop ($nameoffield)
	Return SQL string to aggregate using the Standard Deviation of population. More...

	hintindex ($nameofindex)
	Return SQL string to force an index. More...

	idate ($param, $gm='tzserver')
	Convert (by PHP) a GM Timestamp date into a string date with PHP server TZ to insert into a date field. More...

	lasterrno ()
	Return last error code. More...

	sanitize ($stringtosanitize, $allowsimplequote=0, $allowsequals=0, $allowsspace=0, $allowschars=1)
	Sanitize a string for SQL forging. More...

	begin ($textinlog='')
	Start transaction. More...

	commit ($log='')
	Validate a database transaction. More...

	rollback ($log='')
	Cancel a transaction and go back to initial data values. More...

	getVersionArray ()
	Return version of database server into an array. More...

	lastquery ()
	Return last request executed with query() More...

	order ($sortfield='', $sortorder='')
	Define sort criteria of request. More...

	lasterror ()
	Return last error label. More...

	jdate ($string, $gm='tzserver')
	Convert (by PHP) a PHP server TZ string date into a Timestamps date (GMT if gm=true) 19700101020000 -> 3600 with server TZ = +1 and $gm='tzserver' 19700101020000 -> 7200 whaterver is server TZ if $gm='gmt'. More...

	lastqueryerror ()
	Return last query in error. More...

	getRow ($sql)
	Return first result from query as object Note : This method executes a given SQL query and retrieves the first row of results as an object. More...

	getRows ($sql)
	Return all results from query as an array of objects. More...

Public Member Functions inherited from Database
	idate ($param)
	Convert (by PHP) a GM Timestamp date into a string date with PHP server TZ to insert into a date field. More...

	convertSQLFromMysql ($line, $type='ddl')
	Convert a SQL request in Mysql syntax to native syntax. More...

	sanitize ($stringtosanitize)
	Sanitize a string for SQL forging. More...

Public Attributes
	$type = 'pgsql'
	Database type.

const	LABEL = 'PostgreSQL'
	Database label.

	$forcecharset = 'UTF8'
	Charset.

	$forcecollate = ''
	Collate used to force collate when creating database.

const	VERSIONMIN = '9.0.0'
	Version min database.

Public Attributes inherited from DoliDB
const	VERSIONMIN = self::VERSIONMIN
	Force subclass to implement VERSIONMIN - required DB version.

const	LABEL = self::LABEL
	Force subclass to implement LABEL - description of DB type.

Detailed Description

Class to drive a PostgreSQL database for Dolibarr.

Definition at line 37 of file pgsql.class.php.

Constructor & Destructor Documentation

◆ __construct()

DoliDBPgsql::__construct	(	$type,
		$host,
		$user,
		$pass,
		$name = `''`,
		$port = `0`
	)

Constructor.

This create an opened connection to a database server and eventually to a database

Parameters

string	$type	Type of database (mysql, pgsql...). Not used.
string	$host	Address of database server
string	$user	Nom de l'utilisateur autorise
string	$pass	Password
string	$name	Nom de la database
int	$port	Port of database server

Definition at line 80 of file pgsql.class.php.

Member Function Documentation

◆ affected_rows()

DoliDBPgsql::affected_rows ( $resultset )

Return the number of lines in the result of a request INSERT, DELETE or UPDATE.

Parameters

resource $resultset Result set of request

Returns: int Nb of lines

See also: num_rows()

Implements Database.

Definition at line 664 of file pgsql.class.php.

◆ close()

DoliDBPgsql::close ( )

Close database connection.

Returns: boolean True if disconnect successful, false otherwise

See also: connect()

Implements Database.

Definition at line 494 of file pgsql.class.php.

References dol_syslog().

◆ connect()

DoliDBPgsql::connect	(	$host,
		$login,
		$passwd,
		$name,
		$port = `0`
	)

Connection to server.

Parameters

string	$host	Database server host
string	$login	Login
string	$passwd	Password
string	$name	Name of database (not used for mysql, used for pgsql)
integer	$port	Port of database server

Returns: false|resource Database access handler

See also: close()

Implements Database.

Definition at line 409 of file pgsql.class.php.

◆ convertSQLFromMysql()

DoliDBPgsql::convertSQLFromMysql	(	$line,
		$type = `'auto'`,
		$unescapeslashquot = `false`
	)

Convert a SQL request in Mysql syntax to native syntax.

Parameters

string	$line	SQL request line to convert
string	$type	Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
bool	$unescapeslashquot	Unescape "slash quote" with "quote quote"

Returns: string SQL request line converted

Definition at line 159 of file pgsql.class.php.

Referenced by query().

◆ DDLAddField()

DoliDBPgsql::DDLAddField	(	$table,
		$field_name,
		$field_desc,
		$field_position = `""`
	)

Create a new field into table.

Parameters

string	$table	Name of table
string	$field_name	Name of field to add
	array{type:string,label:string,enabled:int<0,2>\|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string}	$field_desc Associative array of description of the field to insert [parameter name][parameter value]
string	$field_position	Optionnel ex.: "after champtruc"

Returns: int Return integer <0 if KO, >0 if OK

Implements Database.

Definition at line 1200 of file pgsql.class.php.

◆ DDLCreateDb()

DoliDBPgsql::DDLCreateDb	(	$database,
		$charset = `''`,
		$collation = `''`,
		$owner = `''`
	)

Create a new database Do not use function xxx_create_db (xxx=mysql, ...) as they are deprecated We force to create database with charset this->forcecharset and collate this->forcecollate.

Parameters

string	$database	Database name to create
string	$charset	Charset used to store data
string	$collation	Charset used to sort data
string	$owner	Username of database owner

Returns: false|resource Resource defined if OK, null if KO

Implements Database.

Definition at line 939 of file pgsql.class.php.

◆ DDLCreateTable()

DoliDBPgsql::DDLCreateTable	(	$table,
		$fields,
		$primary_key,
		$type,
		$unique_keys = `null`,
		$fulltext_keys = `null`,
		$keys = `null`
	)

Create a table into database.

Parameters

string	$table	Nom de la table
	array<string,array{type:string,label:string,enabled:int<0,2>\|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string}>	$fields Tableau associatif [nom champ][tableau des descriptions]
string	$primary_key	Nom du champ qui sera la clef primaire
string	$type	Type de la table
array	$unique_keys	Tableau associatifs Nom de champs qui seront clef unique => valeur
array	$fulltext_keys	Tableau des Nom de champs qui seront indexes en fulltext
array	$keys	Tableau des champs cles noms => valeur

Returns: int Return integer <0 if KO, >=0 if OK

Implements Database.

Definition at line 1068 of file pgsql.class.php.

◆ DDLCreateUser()

DoliDBPgsql::DDLCreateUser	(	$dolibarr_main_db_host,
		$dolibarr_main_db_user,
		$dolibarr_main_db_pass,
		$dolibarr_main_db_name
	)

Create a user to connect to database.

Parameters

string	$dolibarr_main_db_host	Ip server
string	$dolibarr_main_db_user	Name of user to create
string	$dolibarr_main_db_pass	Password of user to create
string	$dolibarr_main_db_name	Database name where user must be granted

Returns: int Return integer <0 if KO, >=0 if OK

Implements Database.

Definition at line 1316 of file pgsql.class.php.

References $sql, dol_syslog(), and escape().

◆ DDLDescTable()

DoliDBPgsql::DDLDescTable	(	$table,
		$field = `""`
	)

Return a pointer of line with description of a table or field.

Parameters

string	$table	Name of table
string	$field	Optionnel : Name of field if we want description of field

Returns: false|resource Resultset x (x->attname)

Implements Database.

Definition at line 1176 of file pgsql.class.php.

◆ DDLDropField()

DoliDBPgsql::DDLDropField	(	$table,
		$field_name
	)

Drop a field from table.

Parameters

string	$table	Name of table
string	$field_name	Name of field to drop

Returns: int Return integer <0 if KO, >0 if OK

Implements Database.

Definition at line 1293 of file pgsql.class.php.

◆ DDLDropTable()

DoliDBPgsql::DDLDropTable ( $table )

Drop a table into database.

Parameters

string $table Name of table

Returns: int Return integer <0 if KO, >=0 if OK

Implements Database.

Definition at line 1154 of file pgsql.class.php.

◆ DDLGetConnectId()

DoliDBPgsql::DDLGetConnectId ( )

Return connection ID.

Returns: string Id connection

Implements Database.

Definition at line 919 of file pgsql.class.php.

◆ DDLInfoTable()

DoliDBPgsql::DDLInfoTable ( $table )

List information of columns into a table.

Parameters

string $table Name of table

Returns: array Array with information on table

Implements Database.

Definition at line 1024 of file pgsql.class.php.

◆ DDLListTables()

DoliDBPgsql::DDLListTables	(	$database,
		$table = `''`
	)

List tables into a database.

Parameters

string	$database	Name of database
string	$table	Name of table filter ('xxx')

Returns: array List of tables in an array

Implements Database.

Definition at line 969 of file pgsql.class.php.

◆ DDLListTablesFull()

DoliDBPgsql::DDLListTablesFull	(	$database,
		$table = `''`
	)

List tables into a database.

Parameters

string	$database	Name of database
string	$table	Name of table filter ('xxx')

Returns: array List of tables in an array

Implements Database.

Definition at line 997 of file pgsql.class.php.

◆ DDLUpdateField()

DoliDBPgsql::DDLUpdateField	(	$table,
		$field_name,
		$field_desc
	)

Update format of a field into a table.

Parameters

string	$table	Name of table
string	$field_name	Name of field to modify
	array{type:string,label:string,enabled:int<0,2>\|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string}	$field_desc Array with description of field format

Returns: int Return integer <0 if KO, >0 if OK

Implements Database.

Definition at line 1248 of file pgsql.class.php.

◆ decrypt()

DoliDBPgsql::decrypt ( $value )

Decrypt sensitive data in database.

Parameters

string $value Value to decrypt

Returns: string Decrypted value if used

Implements Database.

Definition at line 898 of file pgsql.class.php.

◆ encrypt()

DoliDBPgsql::encrypt	(	$fieldorvalue,
		$withQuotes = `1`
	)

Encrypt sensitive data in database Warning: This function includes the escape and add the SQL simple quotes on strings.

Parameters

string	$fieldorvalue	Field name or value to encrypt
int	$withQuotes	Return string including the SQL simple quotes. This param must always be 1 (Value 0 is bugged and deprecated).

Returns: string XXX(field) or XXX('value') or field or 'value'

Implements Database.

Definition at line 877 of file pgsql.class.php.

◆ errno()

DoliDBPgsql::errno ( )

Renvoie le code erreur generique de l'operation precedente.

Returns: string Error code (Examples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...)

Implements Database.

Definition at line 778 of file pgsql.class.php.

◆ error()

DoliDBPgsql::error ( )

Renvoie le texte de l'erreur pgsql de l'operation precedente.

Returns: string Error text

Implements Database.

Definition at line 842 of file pgsql.class.php.

◆ escape()

DoliDBPgsql::escape ( $stringtoencode )

Escape a string to insert data.

Parameters

string $stringtoencode String to escape

Returns: string String escaped

Implements Database.

Definition at line 726 of file pgsql.class.php.

Referenced by DDLCreateUser(), and regexpsql().

◆ escapeforlike()

DoliDBPgsql::escapeforlike ( $stringtoencode )

Escape a string to insert data into a like.

Parameters

string $stringtoencode String to escape

Returns: string String escaped

Implements Database.

Definition at line 737 of file pgsql.class.php.

◆ fetch_array()

DoliDBPgsql::fetch_array ( $resultset )

Return datas as an array.

Parameters

resource $resultset Resultset of request

Returns: false|array Array

Implements Database.

Definition at line 611 of file pgsql.class.php.

◆ fetch_object()

DoliDBPgsql::fetch_object ( $resultset )

Returns the current line (as an object) for the resultset cursor.

Parameters

resource $resultset Curseur de la requete voulue

Returns: false|object Object result line or false if KO or end of cursor

Implements Database.

Definition at line 594 of file pgsql.class.php.

◆ fetch_row()

DoliDBPgsql::fetch_row ( $resultset )

Return datas as an array.

Parameters

resource $resultset Resultset of request

Returns: false|array Array

Implements Database.

Definition at line 628 of file pgsql.class.php.

◆ free()

DoliDBPgsql::free ( $resultset = null )

Libere le dernier resultset utilise sur cette connection.

Parameters

resource $resultset Result set of request

Returns: void

Implements Database.

Definition at line 683 of file pgsql.class.php.

◆ getDefaultCharacterSetDatabase()

DoliDBPgsql::getDefaultCharacterSetDatabase ( )

Return charset used to store data in database.

Returns: string Charset

Implements Database.

Definition at line 1336 of file pgsql.class.php.

◆ getDefaultCollationDatabase()

DoliDBPgsql::getDefaultCollationDatabase ( )

Return collation used in database.

Returns: string Collation value

Implements Database.

Definition at line 1375 of file pgsql.class.php.

◆ getDriverInfo()

DoliDBPgsql::getDriverInfo ( )

Return version of database client driver.

Returns: string Version string

Implements Database.

Definition at line 483 of file pgsql.class.php.

◆ getListOfCharacterSet()

DoliDBPgsql::getListOfCharacterSet ( )

Return list of available charset that can be used to store data in database.

Returns: array|null List of Charset

Implements Database.

Definition at line 1352 of file pgsql.class.php.

◆ getListOfCollation()

DoliDBPgsql::getListOfCollation ( )

Return list of available collation that can be used for database.

Returns: array|null Liste of Collation

Implements Database.

Definition at line 1391 of file pgsql.class.php.

◆ getPathOfDump()

DoliDBPgsql::getPathOfDump ( )

Return full path of dump program.

Returns: string Full path of dump program

Implements Database.

Definition at line 1413 of file pgsql.class.php.

◆ getPathOfRestore()

DoliDBPgsql::getPathOfRestore ( )

Return full path of restore program.

Returns: string Full path of restore program

Implements Database.

Definition at line 1437 of file pgsql.class.php.

◆ getServerParametersValues()

DoliDBPgsql::getServerParametersValues ( $filter = '' )

Return value of server parameters.

Parameters

string $filter Filter list on a particular value

Returns: array Array of key-values (key=>value)

Implements Database.

Definition at line 1465 of file pgsql.class.php.

◆ getServerStatusValues()

DoliDBPgsql::getServerStatusValues ( $filter = '' )

Return value of server status.

Parameters

string $filter Filter list on a particular value

Returns: array Array of key-values (key=>value)

Implements Database.

Definition at line 1489 of file pgsql.class.php.

◆ getVersion()

DoliDBPgsql::getVersion ( )

Return version of database server.

Returns: string Version string

Implements Database.

Definition at line 468 of file pgsql.class.php.

◆ ifsql()

DoliDBPgsql::ifsql	(	$test,
		$resok,
		$resko
	)

Format a SQL IF.

Parameters

string	$test	Test expression (example: 'cd.statut=0', 'field IS NULL')
string	$resok	Result to generate when test is True
string	$resko	Result to generate when test is False

Returns: string chaine format SQL

Reimplemented from DoliDB.

Definition at line 750 of file pgsql.class.php.

◆ last_insert_id()

DoliDBPgsql::last_insert_id	(	$tab,
		$fieldid = `'rowid'`
	)

Get last ID after an insert INSERT.

Parameters

string	$tab	Table name concerned by insert. Ne sert pas sous MySql mais requis pour compatibilite avec PostgreSQL
string	$fieldid	Field name

Returns: int Id of row

Implements Database.

Definition at line 855 of file pgsql.class.php.

◆ num_rows()

DoliDBPgsql::num_rows ( $resultset )

Return number of lines for result of a SELECT.

Parameters

resource $resultset Resulset of requests

Returns: int Nb of lines, -1 on error

See also: affected_rows()

Implements Database.

Definition at line 646 of file pgsql.class.php.

◆ plimit()

DoliDBPgsql::plimit	(	$limit = `0`,
		$offset = `0`
	)

Define limits and offset of request.

Parameters

int	$limit	Maximum number of lines returned (-1=conf->liste_limit, 0=no limit)
int	$offset	Numero of line from where starting fetch

Returns: string String with SQL syntax to add a limit and offset

Reimplemented from DoliDB.

Definition at line 703 of file pgsql.class.php.

◆ query()

resource boolean Resultset of last DoliDBPgsql::query	(	$query,
		$usesavepoint = `0`,
		$type = `'auto'`,
		$result_mode = `0`
	)

Convert request to PostgreSQL syntax, execute it and return the resultset.

Parameters

string	$query	SQL query string
int	$usesavepoint	0=Default mode, 1=Run a savepoint before and a rollback to savepoint if error (this allow to have some request with errors inside global transactions).
string	$type	Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
int	$result_mode	Result mode (not used with pgsql)

Returns: bool|resource Resultset of answer

Implements Database.

Definition at line 515 of file pgsql.class.php.

References $type, convertSQLFromMysql(), dol_syslog(), getDolGlobalString(), DoliDB\lasterrno(), DoliDB\lasterror(), and DoliDB\lastquery().

◆ regexpsql()

DoliDBPgsql::regexpsql	(	$subject,
		$pattern,
		$sqlstring = `0`
	)

Format a SQL REGEXP.

Parameters

string	$subject	Field name to test
string	$pattern	SQL pattern to match
int	$sqlstring	0=the string being tested is a hard coded string, 1=the string is a field

Returns: string SQL string

Reimplemented from DoliDB.

Definition at line 763 of file pgsql.class.php.

References escape().

◆ select_db()

DoliDBPgsql::select_db ( $database )

Select a database PostgreSQL does not have an equivalent for mysql_select_db Only compare if the chosen DB is the one active on the connection.

Parameters

string $database Name of database

Returns: bool true if OK, false if KO

Implements Database.

Definition at line 388 of file pgsql.class.php.

The documentation for this class was generated from the following file:

dolibarr_dev/htdocs/core/db/pgsql.class.php

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ affected_rows()

◆ close()

◆ connect()

◆ convertSQLFromMysql()

◆ DDLAddField()

◆ DDLCreateDb()

◆ DDLCreateTable()

◆ DDLCreateUser()

◆ DDLDescTable()

◆ DDLDropField()

◆ DDLDropTable()

◆ DDLGetConnectId()

◆ DDLInfoTable()

◆ DDLListTables()

◆ DDLListTablesFull()

◆ DDLUpdateField()

◆ decrypt()

◆ encrypt()

◆ errno()

◆ error()

◆ escape()

◆ escapeforlike()

◆ fetch_array()

◆ fetch_object()

◆ fetch_row()

◆ free()

◆ getDefaultCharacterSetDatabase()

◆ getDefaultCollationDatabase()

◆ getDriverInfo()

◆ getListOfCharacterSet()

◆ getListOfCollation()

◆ getPathOfDump()

◆ getPathOfRestore()

◆ getServerParametersValues()

◆ getServerStatusValues()

◆ getVersion()

◆ ifsql()

◆ last_insert_id()

◆ num_rows()

◆ plimit()

◆ query()

◆ regexpsql()

◆ select_db()