dolibarr  18.0.0
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
DoliDBPgsql Class Reference

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

Inheritance diagram for DoliDBPgsql:
Inheritance graph
[legend]
Collaboration diagram for DoliDBPgsql:
Collaboration graph
[legend]

Public Member Functions

 __construct ($type, $host, $user, $pass, $name='', $port=0)
 Constructor. More...
 
 select_db ($database)
 Select a database Ici postgresql n'a aucune fonction equivalente de mysql_select_db On compare juste manuellement si la database choisie est bien celle activee par la connexion. More...
 
 connect ($host, $login, $passwd, $name, $port=0)
 Connexion to server. More...
 
 getVersion ()
 Return version of database server. More...
 
 getDriverInfo ()
 Return version of database client driver. More...
 
 close ()
 Close database connexion. 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 connexion. 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=false)
 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 connexion 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...
 
 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...
 
 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...
 
 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...
 
 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)
 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 Note : This method executes a given SQL query and retrieves all row of results 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...
 
 sanitize ($stringtosanitize)
 Sanitize a string for SQL forging. More...
 

Static Public Member Functions

static convertSQLFromMysql ($line, $type='auto', $unescapeslashquot=false)
 Convert a SQL request in Mysql syntax to native syntax. More...
 
- Static Public Member Functions inherited from Database
static convertSQLFromMysql ($line, $type='ddl')
 Convert a SQL request in Mysql syntax to native syntax. 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.
 

Detailed Description

Class to drive a Postgresql database for Dolibarr.

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

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

Parameters
string$typeType of database (mysql, pgsql...)
string$hostAddress of database server
string$userNom de l'utilisateur autorise
string$passMot de passe
string$nameNom de la database
int$portPort of database server

Definition at line 71 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$resultsetResult set of request
Returns
int Nb of lines
See also
num_rows()

Implements Database.

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

◆ close()

DoliDBPgsql::close ( )

Close database connexion.

Returns
boolean True if disconnect successfull, false otherwise
See also
connect()

Implements Database.

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

References dol_syslog().

◆ connect()

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

Connexion to server.

Parameters
string$hostDatabase server host
string$loginLogin
string$passwdPassword
string$nameName of database (not used for mysql, used for pgsql)
integer$portPort of database server
Returns
bool|resource Database access handler
See also
close()

Implements Database.

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

◆ convertSQLFromMysql()

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

Convert a SQL request in Mysql syntax to native syntax.

Parameters
string$lineSQL request line to convert
string$typeType of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
bool$unescapeslashquotUnescape slash quote with quote quote
Returns
string SQL request line converted

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

◆ DDLAddField()

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

Create a new field into table.

Parameters
string$tableName of table
string$field_nameName of field to add
string$field_descTableau associatif de description du champ a inserer[nom du parametre][valeur du parametre]
string$field_positionOptionnel ex.: "after champtruc"
Returns
int <0 if KO, >0 if OK

Implements Database.

Definition at line 1206 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$databaseDatabase name to create
string$charsetCharset used to store data
string$collationCharset used to sort data
string$ownerUsername of database owner
Returns
false|resource resource defined if OK, null if KO

Implements Database.

Definition at line 932 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$tableNom de la table
array$fieldsTableau associatif [nom champ][tableau des descriptions]
string$primary_keyNom du champ qui sera la clef primaire
string$typeType de la table
array$unique_keysTableau associatifs Nom de champs qui seront clef unique => valeur
array$fulltext_keysTableau des Nom de champs qui seront indexes en fulltext
array$keysTableau des champs cles noms => valeur
Returns
int <0 if KO, >=0 if OK

Implements Database.

Definition at line 1061 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_hostIp server
string$dolibarr_main_db_userName of user to create
string$dolibarr_main_db_passPassword of user to create
string$dolibarr_main_db_nameDatabase name where user must be granted
Returns
int <0 if KO, >=0 if OK

Implements Database.

Definition at line 1159 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$tableName of table
string$fieldOptionnel : Name of field if we want description of field
Returns
false|resource Resultset x (x->attname)

Implements Database.

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

◆ DDLDropField()

DoliDBPgsql::DDLDropField (   $table,
  $field_name 
)

Drop a field from table.

Parameters
string$tableName of table
string$field_nameName of field to drop
Returns
int <0 if KO, >0 if OK

Implements Database.

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

◆ DDLDropTable()

DoliDBPgsql::DDLDropTable (   $table)

Drop a table into database.

Parameters
string$tableName of table
Returns
int <0 if KO, >=0 if OK

Implements Database.

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

◆ DDLGetConnectId()

DoliDBPgsql::DDLGetConnectId ( )

Return connexion ID.

Returns
string Id connexion

Implements Database.

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

◆ DDLInfoTable()

DoliDBPgsql::DDLInfoTable (   $table)

List information of columns into a table.

Parameters
string$tableName of table
Returns
array Tableau des informations des champs de la table

Implements Database.

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

◆ DDLListTables()

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

List tables into a database.

Parameters
string$databaseName of database
string$tableName of table filter ('xxx')
Returns
array List of tables in an array

Implements Database.

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

◆ DDLListTablesFull()

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

List tables into a database.

Parameters
string$databaseName of database
string$tableName of table filter ('xxx')
Returns
array List of tables in an array

Implements Database.

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

◆ DDLUpdateField()

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

Update format of a field into a table.

Parameters
string$tableName of table
string$field_nameName of field to modify
string$field_descArray with description of field format
Returns
int <0 if KO, >0 if OK

Implements Database.

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

◆ decrypt()

DoliDBPgsql::decrypt (   $value)

Decrypt sensitive data in database.

Parameters
int$valueValue to decrypt
Returns
string Decrypted value if used

Implements Database.

Definition at line 891 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$fieldorvalueField name or value to encrypt
int$withQuotesReturn 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 870 of file pgsql.class.php.

◆ errno()

DoliDBPgsql::errno ( )

Renvoie le code erreur generique de l'operation precedente.

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

Implements Database.

Definition at line 771 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 835 of file pgsql.class.php.

◆ escape()

DoliDBPgsql::escape (   $stringtoencode)

Escape a string to insert data.

Parameters
string$stringtoencodeString to escape
Returns
string String escaped

Implements Database.

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

Referenced by DDLCreateUser().

◆ escapeforlike()

DoliDBPgsql::escapeforlike (   $stringtoencode)

Escape a string to insert data into a like.

Parameters
string$stringtoencodeString to escape
Returns
string String escaped

Implements Database.

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

◆ fetch_array()

DoliDBPgsql::fetch_array (   $resultset)

Return datas as an array.

Parameters
resource$resultsetResultset of request
Returns
false|array Array

Implements Database.

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

◆ fetch_object()

DoliDBPgsql::fetch_object (   $resultset)

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

Parameters
resource$resultsetCurseur de la requete voulue
Returns
false|object Object result line or false if KO or end of cursor

Implements Database.

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

◆ fetch_row()

DoliDBPgsql::fetch_row (   $resultset)

Return datas as an array.

Parameters
resource$resultsetResultset of request
Returns
false|array Array

Implements Database.

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

◆ free()

DoliDBPgsql::free (   $resultset = null)

Libere le dernier resultset utilise sur cette connexion.

Parameters
resource$resultsetResult set of request
Returns
void

Implements Database.

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

◆ getDefaultCharacterSetDatabase()

DoliDBPgsql::getDefaultCharacterSetDatabase ( )

Return charset used to store data in database.

Returns
string Charset

Implements Database.

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

◆ getDefaultCollationDatabase()

DoliDBPgsql::getDefaultCollationDatabase ( )

Return collation used in database.

Returns
string Collation value

Implements Database.

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

◆ getDriverInfo()

DoliDBPgsql::getDriverInfo ( )

Return version of database client driver.

Returns
string Version string

Implements Database.

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

◆ getListOfCharacterSet()

DoliDBPgsql::getListOfCharacterSet ( )

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

Returns
array List of Charset

Implements Database.

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

◆ getListOfCollation()

DoliDBPgsql::getListOfCollation ( )

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

Returns
array Liste of Collation

Implements Database.

Definition at line 1370 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 1392 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 1416 of file pgsql.class.php.

◆ getServerParametersValues()

DoliDBPgsql::getServerParametersValues (   $filter = '')

Return value of server parameters.

Parameters
string$filterFilter list on a particular value
Returns
array Array of key-values (key=>value)

Implements Database.

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

◆ getServerStatusValues()

DoliDBPgsql::getServerStatusValues (   $filter = '')

Return value of server status.

Parameters
string$filterFilter list on a particular value
Returns
array Array of key-values (key=>value)

Implements Database.

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

◆ getVersion()

DoliDBPgsql::getVersion ( )

Return version of database server.

Returns
string Version string

Implements Database.

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

◆ ifsql()

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

Format a SQL IF.

Parameters
string$testTest string (example: 'cd.statut=0', 'field IS NULL')
string$resokresultat si test egal
string$reskoresultat si test non egal
Returns
string chaine formate SQL

Reimplemented from DoliDB.

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

◆ last_insert_id()

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

Get last ID after an insert INSERT.

Parameters
string$tabTable name concerned by insert. Ne sert pas sous MySql mais requis pour compatibilite avec Postgresql
string$fieldidField name
Returns
string Id of row

Implements Database.

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

◆ num_rows()

DoliDBPgsql::num_rows (   $resultset)

Return number of lines for result of a SELECT.

Parameters
resource$resultsetResulset of requests
Returns
int Nb of lines, -1 on error
See also
affected_rows()

Implements Database.

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

◆ plimit()

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

Define limits and offset of request.

Parameters
int$limitMaximum number of lines returned (-1=conf->liste_limit, 0=no limit)
int$offsetNumero of line from where starting fetch
Returns
string String with SQL syntax to add a limit and offset

Reimplemented from DoliDB.

Definition at line 696 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$querySQL query string
int$usesavepoint0=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$typeType of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
int$result_modeResult mode (not used with pgsql)
Returns
bool|resource Resultset of answer

Implements Database.

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

◆ regexpsql()

DoliDBPgsql::regexpsql (   $subject,
  $pattern,
  $sqlstring = false 
)

Format a SQL REGEXP.

Parameters
string$subjectstring tested
string$patternSQL pattern to match
string$sqlstringwhether or not the string being tested is an SQL expression
Returns
string SQL string

Reimplemented from DoliDB.

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

◆ select_db()

DoliDBPgsql::select_db (   $database)

Select a database Ici postgresql n'a aucune fonction equivalente de mysql_select_db On compare juste manuellement si la database choisie est bien celle activee par la connexion.

Parameters
string$databaseName of database
Returns
bool true if OK, false if KO

Implements Database.

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


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