Software Development Kit

cPanel & WHM's API [+] cPanel & WHM's API [-]


Modules and Plugins [+] Modules and Plugins [-]


cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]


cPAddons (Site Software) [+] cPAddons (Site Software) [-]


System Administration [+] System Administration [-]


Developer Software [+] Developer Software [-]


Back to All Documentation



integrationblogcta.jpg

Postgres Module Documentation

This module allows you to access cPanel's PostgreSQL functions.

The functions within this module may or may not be governed by a feature list. The required feature list may vary from function to function, to review a total list of the available features sets on a cPanel server, please see "Feature Manager" in WHM.

Postgres::listusers

API Version: 2 - Click here for documentation
Description: List Postgres databases and database users.
Returns:  
 
<data>
  <dblist>
    <db> A string value that contains the name of the database.</db>
    <user> A string value that contains a database user.</user>
  </dblist>
  <user> A string value that contains a database user.</user>
</data>

Postgres::listdbs

API Version: 2 - Click here for documentation
Description: List Postgres databases and database users.
Returns:  
 
<data>
  <sizemeg> An integer value that contains the size of the database listed in megabytes.</sizemeg>
  <db> A string value that contains the name of the database.</db>
  <userlist>
    <db> A string value that contains the name of the database.</db>
    <user> A string value that contains a database user.</user>
  </userlist>
  <size> An integer value that contains the size of the database in bytes.</size>
  <usercount> An integer value that contains the number of users assigned to the database.</usercount>
</data>

Postgres::listusersindb

API Version: 2 - Click here for documentation
Description: List database users for a specified Postgres database.
Parameters:  
  db (string)
  The name of the database corresponding to the users you wish to list.
Returns:  
 
<data>
  <db> A string value that contains the name of the database.</db>
  <user> A string value that contains a database user.</user>
</data>

Topic revision: r2 - 26 Mar 2012 - 16:27:02 - Main.JenniferDoubrava