> ## Documentation Index > Fetch the complete documentation index at: https://gcore.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Manage a PostgreSQL server export const MethodSection = ({children}) => children ?? null; export const MethodSwitch = ({children}) => { const tabs = React.Children.toArray(children).map(c => { if (!c || !c.props) return null; if (c.props.id) return c; const inner = c.props.children; if (inner && inner.props && inner.props.id) return inner; return null; }).filter(Boolean); const firstId = tabs.length > 0 ? tabs[0].props.id : ""; const [active, setActive] = React.useState(firstId); React.useEffect(() => { try { const saved = localStorage.getItem("gcore_docs_method"); if (saved && tabs.find(t => t.props.id === saved)) { setActive(saved); } } catch (_) {} }, []); React.useEffect(() => { try { document.querySelectorAll("h2[id], h3[id]").forEach(heading => { const visible = heading.offsetParent !== null; document.querySelectorAll(`a[href="#${heading.id}"]`).forEach(link => { if (link.closest("h1,h2,h3,h4,h5,h6")) return; const li = link.closest("li"); if (li) li.style.display = visible ? "" : "none"; }); }); } catch (_) {} window.dispatchEvent(new Event("scroll")); }, [active]); const handleClick = id => { setActive(id); try { localStorage.setItem("gcore_docs_method", id); } catch (_) {} }; return
{tabs.map(tab => { const isActive = active === tab.props.id; return ; })}
{tabs.map(tab =>
{tab.props.children}
)}
; }; ## Create a server This guide describes how to create a PostgreSQL server. ### Before you begin Before creating a PostgreSQL server, ensure sufficient quotas are available for the target region. 1\. Go to **Cloud Management**, then **Quotas Viewer** and select the region. manage postgresql 2\. On the **Database Service** tab, select the number of PostgreSQL clusters you need and specify the reason in the field on the right. 3\. Click **Send request**. manage postgresql send quotas request Requests are typically processed within fifteen minutes. If the quota is not increased after that time, contact [support](mailto:support@gcore.com). ### Create a server 1\. In the Cloud menu, navigate to **Managed PostgreSQL** and click **Create PostgreSQL server**. manage postgresql create a server 2\. Select the region where the PostgreSQL server will be hosted. manage postgresql choose region 3\. Choose the appropriate [PostgreSQL version](/cloud/managed-database-postgresql#supported-versions). manage postgresql select version 4\. In **Compute**, select the server flavor. Optionally, set custom DBMS settings via text mode in the window that opens. manage postgresql select server flavor 5\. In **Storage**, choose the volume type and size. manage postgresql choose volume 6\. (Optionally) Switch on the **Enable high availability** toggle in **PG configuration** to deploy three replicas with the same configuration, ensuring the database remains accessible if the primary server fails. When this feature is enabled, select the appropriate replication mode: * Asynchronous: In asynchronous replication, servers work independently. The primary database sends the changes to the replicas and does not wait for confirmation that the changes have been applied. This mode is suitable for scenarios where data consistency with some level of delay is acceptable, though high performance is crucial. * Synchronous: In synchronous replication, the primary database must wait for confirmation that the changes have been applied in the replica databases. The changes are replicated in real time or near-real time. It provides full protection against data loss but may have lower performance. manage postgresql manage replication mode This feature can be enabled or disabled later. 7\. In **Network settings**, configure the network interface. Select **Public** and configure the **Access control list** to limit server access to specific IP addresses. manage postgresql manage network interface Adding `0.0.0.0/0` allows unrestricted access from all IP addresses on the internet. Use this setting only temporarily and exclusively on test servers that do not contain sensitive data. 8\. In **Authentication**, enter a username for the initial database user. manage postgresql manage authentication 9\. In **Databases**, enter the database name and select the owner. 10\. In **Server details**, specify the server name. The database size limit is 100 GB during beta. For a larger database size, contact [support](mailto:support@gcore.com). manage postgresql specify server details 11\. Click **Create PostgreSQL server** in the panel on the right. The server will be created in a few minutes. ## Get your credentials This guide explains how to obtain the password for a PostgreSQL server and how to reset it. 1\. Go to **Managed PostgreSQL** and select the server. 2\. Click **Generate credentials**. manage postgresql generate credentials 3\. Copy and save the password immediately — it cannot be recovered after the window is closed. If the password is lost, it can only be reset. A new password will be generated and the previous one deactivated. 4\. Click **OK**. ## Upgrade the PostgreSQL version To upgrade to a newer PostgreSQL version: 1\. Go to **Managed PostgreSQL** and select the server. 2\. On the **Overview** tab, click **Update** in the General info section. If the latest version is already installed, the **Update** button is not displayed. manage postgresql update version 3\. Select the version you need from the drop-down list and click **Update**. manage postgresql update version pop up ## Delete a server 1\. Go to **Managed PostgreSQL** and select the server to delete. 2\. Click **Delete server**. manage postgresql delete server 3\. In the confirmation window, type *Delete* and click **Delete server**. manage postgresql confirm deletion ## Connect to a PostgreSQL server This guide explains the available tools for accessing a PostgreSQL server and how to connect using psql and pgAdmin. ### Before you begin Before connecting to a PostgreSQL server, complete the following steps: 1\. Collect the connection details: manage postgresql connection details * **Endpoint**: available in the **Connection details** section * **Username**: available in the **Connection details** section * **Port**: available by copying the connection strings from **Connection details** * **Password**: generated separately after server creation. If the password was lost, [reset it](/cloud/managed-database-postgresql/manage-postgresql-servers#get-your-credentials). 2\. Ensure the client computer's external IP address is included in the access control list (ACL) of the PostgreSQL server. 3\. Choose a connection tool: * **psql (Postgres Terminal Monitor)**: The command-line PostgreSQL client for entering, editing, and executing SQL commands directly from a terminal or command prompt. * **Native frontend tools** (e.g., pgaccess, pgAdmin, ApplixWare): Graphical user interfaces (GUIs) for PostgreSQL database management, offering a more visual way to create and manage databases. * **Programming languages** (e.g., Perl, Tcl): These languages have PostgreSQL interfaces and can be used to write scripts or applications that connect to PostgreSQL programmatically. For example, pgaccess is a Tcl/Tk-based GUI application. * **C programming with LIBPQ**: The LIBPQ subroutine library enables C programs to connect to PostgreSQL, submit SQL commands, and retrieve results. See "[The PostgreSQL Programmer's Guide](https://www.postgresql.org/docs/7.3/programmer.html)" for details. ### Connect using the psql client 1\. [Download the PostgreSQL client](https://www.postgresql.org/download/) for the target operating system to install psql. 2\. Start psql by typing the following command in your terminal: ```sh theme={null} psql -h hostname -p port -d dbname -U username ``` Replace `hostname`, `port`, `dbname`, and `username` with the actual connection values. 3\. Enter the password and press **Enter**. For more details, refer to the [PostgreSQL official documentation](https://www.postgresql.org/docs/). ### Connect using pgAdmin 1\. [Download](https://www.pgadmin.org/) and install pgAdmin to your client computer. 2\. Launch pgAdmin. 3\. On the **Dashboard** tab, choose **Add New Server**. manage postgresql connect phpmyadmin 1 4\. In the Create - Server dialog box that appears, type the server's name in the **General** tab and click **Save**. manage postgresql connect phpmyadmin 2 5\. Go to the **Connection** tab and enter the host (endpoint,) port, username, and password in the relevant fields. manage postgresql connect phpmyadmin 3 6\. Click **Save**. 7\. Locate the server in the left-side menu and click it to connect. For more details, see the [pgAdmin official documentation](https://www.pgadmin.org/docs/). Gcore Managed PostgreSQL provisions a fully managed database cluster with automatic backups and optional High Availability replication. Four API calls create the cluster, poll the creation task, retrieve the connection string, and expose credentials for a psql session. An [API token](/developer-tools/rest-api/authentication) is required, along with a [project ID](/api-reference/cloud/projects/list-projects) and a [region ID](/api-reference/cloud/regions/list-regions). Open a bash terminal and set these as environment variables before running the examples: ```bash theme={null} export GCORE_API_KEY="{YOUR_API_KEY}" export GCORE_CLOUD_PROJECT_ID="{YOUR_PROJECT_ID}" export GCORE_CLOUD_REGION_ID="{YOUR_REGION_ID}" ``` ## Step 1. Activate the PostgreSQL service The Managed PostgreSQL service requires a one-time activation per project and region before any clusters can be created. ```bash theme={null} curl -s -X PUT "https://api.gcore.com/cloud/v1/dbaas/status/$GCORE_CLOUD_PROJECT_ID/$GCORE_CLOUD_REGION_ID" \ -H "Authorization: APIKey $GCORE_API_KEY" \ -H "Content-Type: application/json" \ -d '{"is_initialized": true}' ``` The API returns: ```json theme={null} { "is_initialized": true } ``` To check whether activation is already done, call GET /cloud/v1/dbaas/status/{project_id}/{region_id} - if `is_initialized` is already `true`, skip this step. ## Step 2. Create the cluster A single create call provisions the database server, configures network access, creates an initial user, and creates the first database. | Parameter | Required | Description | | --------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- | | `cluster_name` | Yes | Cluster identifier. Pattern `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`, max 50 characters | | `pg_server_configuration.version` | Yes | PostgreSQL major version. Supported values: `"15"`, `"14"`, `"13"` | | `pg_server_configuration.pg_conf` | Yes | Custom `postgresql.conf` settings as a string. Pass `""` to use defaults | | `flavor.cpu` | Yes | Number of vCPUs allocated to the instance | | `flavor.memory_gib` | Yes | RAM in GiB | | `storage.type` | Yes | Block storage type. Use `ssd-hiiops` for best performance | | `storage.size_gib` | Yes | Storage size in GiB. Maximum 100 GiB | | `network.acl` | Yes | Allowed source IP addresses in CIDR notation. Use the connecting machine's public IP | | `high_availability` | Yes | Set to `null` for a single-node cluster, or `{"replication_mode": "sync"}` or `{"replication_mode": "async"}` for three-node HA | | `users[].name` | No | Initial database user. Lowercase letters only | | `users[].role_attributes` | No | PostgreSQL role attributes. Include `"CREATEDB"` to allow creating databases from psql | | `databases[].name` | No | Initial database name. Lowercase letters only. Must reference a user in `users[]` as `owner` | ```python theme={null} import os from gcore import Gcore client = Gcore() task_id_list = client.cloud.databases.postgres.clusters.create( project_id=int(os.environ["GCORE_CLOUD_PROJECT_ID"]), region_id=int(os.environ["GCORE_CLOUD_REGION_ID"]), cluster_name="my-postgres", pg_server_configuration={"version": "15", "pg_conf": ""}, flavor={"cpu": 2, "memory_gib": 4}, storage={"type": "ssd-hiiops", "size_gib": 10}, network={ "network_type": "public", "acl": ["{YOUR_IP_ADDRESS}/32"], }, high_availability=None, users=[{"name": "dbuser", "role_attributes": ["INHERIT", "LOGIN", "CREATEDB"]}], databases=[{"name": "mydb", "owner": "dbuser"}], ) print(task_id_list.tasks[0]) ``` ```bash theme={null} curl -s -X POST "https://api.gcore.com/cloud/v1/dbaas/postgres/clusters/$GCORE_CLOUD_PROJECT_ID/$GCORE_CLOUD_REGION_ID" \ -H "Authorization: APIKey $GCORE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "cluster_name": "my-postgres", "pg_server_configuration": { "version": "15", "pg_conf": "" }, "flavor": { "cpu": 2, "memory_gib": 4 }, "storage": { "type": "ssd-hiiops", "size_gib": 10 }, "network": { "network_type": "public", "acl": ["{YOUR_IP_ADDRESS}/32"] }, "high_availability": null, "users": [ {"name": "dbuser", "role_attributes": ["INHERIT", "LOGIN", "CREATEDB"]} ], "databases": [ {"name": "mydb", "owner": "dbuser"} ] }' ``` Response: ```json theme={null} { "tasks": ["bce1a2e8-d40b-4aca-bbad-fa2c3580cf20"] } ``` ```bash theme={null} export TASK_ID="{TASK_ID}" ``` ## Step 3. Poll the task Cluster creation takes 3-5 minutes. Poll every 5 seconds until `state` is `FINISHED`. ```python theme={null} task = client.cloud.tasks.poll( task_id_list.tasks[0], polling_interval_seconds=5, polling_timeout_seconds=600, ) print("Cluster ready:", task.created_resources.postgresql_clusters[0]) ``` ```bash theme={null} curl -s "https://api.gcore.com/cloud/v1/tasks/$TASK_ID" \ -H "Authorization: APIKey $GCORE_API_KEY" ``` When complete: ```json theme={null} { "id": "bce1a2e8-d40b-4aca-bbad-fa2c3580cf20", "state": "FINISHED", "created_resources": { "postgresql_clusters": ["my-postgres"] } } ``` ## Step 4. Get the connection string The cluster detail response includes the host, network configuration, and a connection string template in `network.connection_string`. The password field is masked - retrieve it in Step 5. ```python theme={null} cluster = client.cloud.databases.postgres.clusters.get( cluster_name="my-postgres", project_id=int(os.environ["GCORE_CLOUD_PROJECT_ID"]), region_id=int(os.environ["GCORE_CLOUD_REGION_ID"]), ) print("Status:", cluster.status) print("Host:", cluster.network.host) print("Connection string:", cluster.network.connection_string) ``` ```bash theme={null} CLUSTER_NAME="my-postgres" curl -s "https://api.gcore.com/cloud/v1/dbaas/postgres/clusters/$GCORE_CLOUD_PROJECT_ID/$GCORE_CLOUD_REGION_ID/$CLUSTER_NAME" \ -H "Authorization: APIKey $GCORE_API_KEY" ``` Response: ```json theme={null} { "cluster_name": "my-postgres", "status": "READY", "network": { "network_type": "public", "acl": ["{YOUR_IP_ADDRESS}/32"], "host": "my-postgres-67d2e3927a98d77e71c4804f40c4ce1dd68f010d27b11a.pg.k1.frankfurt-2.cloud.gcore.dev", "connection_string": "postgres://dbuser:*****@my-postgres-67d2e3927a98d77e71c4804f40c4ce1dd68f010d27b11a.pg.k1.frankfurt-2.cloud.gcore.dev:5432/mydb" }, "flavor": {"cpu": 2, "memory_gib": 4}, "storage": {"size_gib": 10, "type": "ssd-hiiops"}, "pg_server_configuration": {"version": "15"}, "users": [{"name": "dbuser", "is_secret_revealed": false}], "databases": [{"name": "mydb", "owner": "dbuser"}] } ``` ```bash theme={null} export CLUSTER_NAME="my-postgres" export PG_HOST="my-postgres-67d2e3927a98d77e71c4804f40c4ce1dd68f010d27b11a.pg.k1.frankfurt-2.cloud.gcore.dev" ``` ## Step 5. Retrieve credentials The credentials endpoint reveals the user password. It can only be called once per user - the password is not stored by Gcore afterward. The second call returns an error. ```python theme={null} creds = client.cloud.databases.postgres.clusters.user_credentials.get( username="dbuser", cluster_name="my-postgres", project_id=int(os.environ["GCORE_CLOUD_PROJECT_ID"]), region_id=int(os.environ["GCORE_CLOUD_REGION_ID"]), ) print(creds.username) print(creds.password) # save immediately - second call raises an error ``` ```bash theme={null} USERNAME="dbuser" curl -s "https://api.gcore.com/cloud/v1/dbaas/postgres/clusters/$GCORE_CLOUD_PROJECT_ID/$GCORE_CLOUD_REGION_ID/$CLUSTER_NAME/users/$USERNAME/credentials" \ -H "Authorization: APIKey $GCORE_API_KEY" ``` Response: ```json theme={null} { "username": "dbuser", "password": "8T8WieWrkMSvrHlLlnAVtJDV4Vhyxz7..." } ``` Calling this endpoint a second time returns: `"Requested credentials already revealed. You must regenerate credentials"`. To reset the password, call POST /cloud/v1/dbaas/postgres/clusters/{project_id}/{region_id}/{cluster_name}/users/{username}/credentials. ## Step 6. Connect with psql With the host and password from the previous steps, open a psql session. Set the password via the `PGPASSWORD` environment variable to avoid an interactive prompt. ```bash theme={null} export PGPASSWORD="{PASSWORD}" psql -h $PG_HOST -p 5432 -U dbuser -d mydb ``` ``` psql (15.x) SSL connection (protocol: TLSv1.3, ...) Type "help" for help. mydb=# ``` Verify the connection and create a table: ```sql theme={null} CREATE TABLE users ( id SERIAL PRIMARY KEY, name TEXT NOT NULL, created_at TIMESTAMPTZ DEFAULT NOW() ); \dt ``` ``` List of relations Schema | Name | Type | Owner --------+-------+-------+-------- public | users | table | dbuser (1 row) ```