Skip to content

Commit

Permalink
Merge pull request #6113 from EnterpriseDB/release-2024-09-30a
Browse files Browse the repository at this point in the history
Release 2024-09-30a
  • Loading branch information
djw-m authored Sep 30, 2024
2 parents ac521e0 + 9933d26 commit 6a15cb7
Show file tree
Hide file tree
Showing 30 changed files with 682 additions and 96 deletions.
3 changes: 3 additions & 0 deletions advocacy_docs/dev-guides/deploy/images/pgadmin-connected.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions advocacy_docs/dev-guides/deploy/images/pgadmin-default.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
163 changes: 163 additions & 0 deletions advocacy_docs/dev-guides/deploy/windows.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
---
title: Installing PostgreSQL for development and testing on Microsoft Windows
navTitle: On Windows
description: Install PostgreSQL on your local Windows machine for development purposes.
product: postgresql
iconName: logos/Windows
---

## Prerequesites

- Windows 10 build 16299 or later
- An account with Administrator rights

## Installing

For a development machine, we'll use [WinGet](https://learn.microsoft.com/en-us/windows/package-manager/winget/) to download and install PostgreSQL:

```
winget install PostgreSQL.PostgreSQL.16
__OUTPUT__
Found PostgreSQL 16 [PostgreSQL.PostgreSQL.16] Version 16.4-1
This application is licensed to you by its owner.
Microsoft is not responsible for, nor does it grant any licenses to, third-party packages.
Downloading https://get.enterprisedb.com/postgresql/postgresql-16.4-1-windows-x64.exe
β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆ 356 MB / 356 MB
Successfully verified installer hash
Starting package install...
Successfully installed
```

...where `16` is the major version of PostgreSQL we wish to install. This will install PostgreSQL in unattended mode (it won't ask you questions on what components to install, where to install them, or what the initial configuration should look like... Although you may be prompted by Windows to approve admin access for the installer). The installer will use the default location (`C:\Program Files\PostgreSQL\`) with the default password (`postgres`) and also install both [StackBuilder](/supported-open-source/postgresql/installing/using_stackbuilder/) and [pgAdmin](https://www.pgadmin.org/).

!!! Tip

You can find a list of available PostgreSQL versions by using WinGet's `search` command:

```
winget search PostgreSQL.PostgreSQL
__OUTPUT__
Name Id Version Source
------------------------------------------------------
PostgreSQL 10 PostgreSQL.PostgreSQL.10 10 winget
PostgreSQL 11 PostgreSQL.PostgreSQL.11 11 winget
PostgreSQL 12 PostgreSQL.PostgreSQL.12 12.20-1 winget
PostgreSQL 13 PostgreSQL.PostgreSQL.13 13.16-1 winget
PostgreSQL 14 PostgreSQL.PostgreSQL.14 14.13-1 winget
PostgreSQL 15 PostgreSQL.PostgreSQL.15 15.8-1 winget
PostgreSQL 16 PostgreSQL.PostgreSQL.16 16.4-1 winget
PostgreSQL 9 PostgreSQL.PostgreSQL.9 9 winget
```

Installers for release candidate versions of PostgreSQL are also available on EDB's website at https://www.enterprisedb.com/downloads/postgres-postgresql-downloads

!!!

!!! SeeAlso "Further reading"

For more control over installation (specifying components, location, port, superuser password...), you can also download and run the installer interactively by following the instructions in [Installing PostgreSQL on Windows](https://www.enterprisedb.com/docs/supported-open-source/postgresql/installing/windows/).

!!!

## Add PostgreSQL commands to your path

PostgreSQL comes with [several useful command-line tools](https://www.postgresql.org/docs/current/reference-client.html) for working with your databases. For convenience, you'll probably want to add their location to your path.

1. Open the System Properties control panel and select the Advanced tab (or run `SystemPropertiesAdvanced.exe`)
2. Activate the "Environment Variables..." button to open the envornment variables editor
3. Find the `Path` variable under the "System variables" heading, and click "Edit..."
4. Add the path to the bin directory of the PostgreSQL version you installed, e.g. `C:\Program Files\postgresql\16\bin\` (where *16* is the version of PostgreSQL that you installed).

!!! Info "This only affects new command prompts"

If you have a command prompt open already, you'll need to close and reopen in order for your changes to the system path to take effect.

!!!

## Verifying your installation

If the steps above completed successfully, you'll now have a PostgreSQL service running with the default database and superuser account. Let's verify this by connecting, creating a new user and database, and then connecting using that user.

### Connect with psql

Open a new command prompt, and run

```
psql -U postgres
__OUTPUT__
Password for user postgres:
psql (16.4)
WARNING: Console code page (437) differs from Windows code page (1252)
8-bit characters might not work correctly. See psql reference
page "Notes for Windows users" for details.
Type "help" for help.
postgres=#
```

When prompted, enter the default password (`postgres`).

!!! Warning

We're setting up an environment for local development, and have no intention of enabling remote connections or working with sensitive data - so leaving the default password is fine. Never leave the default password set on a production or multi-user system!

!!!

It's a good practice to develop with a user and database other than the default (`postgres` database and `postgres` superuser) - this allows us to apply the [principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege) and helps avoid issues later on when you go to deploy: since the superuser is allowed to modify *anything*, you'll never encounter permissions errors even if your app's configuration has you reading or writing to the wrong table, schema or database... Yet that's certainly not the sort of bug you'd wish to ship! So let's start off right by creating an app user and giving it its own database to operate on:

```
create user myapp with password 'app-password';
create database appdb with owner myapp;
__OUTPUT__
CREATE ROLE
CREATE DATABASE
```

!!! SeeAlso "Further reading"

- [Database Roles](https://www.postgresql.org/docs/current/user-manag.html)
- [Privileges](https://www.postgresql.org/docs/current/ddl-priv.html)

!!!

Now let's quit psql and connect with pgAdmin as our new user. Run,

```
\q
```

### Connect with pgAdmin

Launch pgAdmin via the Start menu (you can find it under "PostgreSQL 16", or just type "pgAdmin").

![pgAdmin 4 default view - server groups on left, welcome message on right](images/pgadmin-default.png)

If you poke around a bit (by expanding the Servers group on the left), you'll see that pgAdmin comes with a default connection configured for the `postgres` user to the `postgres` database in our local PostgreSQL server.

Let's add a new connection for our app user to our app database.

1. Right-click the Servers entry on the left, select Register and click Server:

![pgadmin Servers group menu with register item and server submenu item selected](images/pgadmin-register-server.png)

2. On the General tab, give it a descriptive name like "myapp db"

3. Switch to the Connection tab:

enter connection information, using the new role and database we created in psql above:

- `localhost` for Host name/address
- `appdb` for Maintenance database
- `myapp` for Username
- `app-password` for Password

...and check the *Save password?* option and click the Save button.

![pgadmin screen showing two server connections configured under Servers group on left, with PostgreSQL 16 disconnected and myapp db connected and selected, with activity charts for myapp db shown on right](images/pgadmin-connected.png)

Note that some areas that require system-level permissions (e.g., logs) are unavailable, as you're not connected as a superuser. For these, you can use the default superuser connection.

## Conclusion

By following these steps, you've created a local environment for developing against PostgreSQL. You've created your own database and limited-access user to own it, and can proceed to create a schema, connect application frameworks, run tests, etc.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: EDB Data Migration Service
indexCards: simple
deepToC: true
directoryDefaults:
description: "EDB Data Migration Service is a PG AI integrated migration solution that enables secure, fault-tolerant, and performant migrations to EDB Postgres AI Cloud Service."
description: "EDB Data Migration Service is a solution that enables secure, fault-tolerant, and performant migrations to EDB Postgres AI Cloud Service."
product: "data migration service"
iconName: EdbTransporter
navigation:
Expand All @@ -14,8 +14,6 @@ navigation:
- limitations
- "#Get started"
- getting_started
- "#Reference"
- known_issues

---

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
---
title: "Limitations"
title: "Known issues, limitations, and notes"
description: Revise any unsupported data types and features.
---

## General limitations
These are the known issues, limitations, and notes for:

- [General EDB Data Migration Service limitations](#general-edb-data-migration-service-limitations)

- [Oracle limitations](#oracle-limitations)

- [Postgres limitations](#postgres-limitations)

## General EDB Data Migration Service limitations

EDB DMS doesn’t currently support migrating schemas, tables, and columns that have case-sensitive names.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To perform an installation using the graphical installation wizard, you need sup

!!!note Notes
- EDB doesn't support all non-ASCII, multi-byte characters in user or machine names. Use ASCII characters only to avoid installation errors related to unsupported path names.
- If you're using the graphical installation wizard to perform a system ***upgrade***, the installer preserves the configuration options specified during the previous installation.
- If you're using the graphical installation wizard to perform a system upgrade, the installer preserves the configuration options specified during the previous installation.
!!!

1. To start the installation wizard, assume sufficient privileges, and double-click the installer icon. If prompted, provide a password. (In some versions of Windows, to invoke the installer with administrator privileges, you must select **Run as Administrator** from the installer icon's context menu.)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ When the `CREATE DATABASE LINK` command is given, the database link name and the
A SQL command containing a reference to a database link must be issued while connected to the local database. When the SQL command is executed, the appropriate authentication and connection is made to the remote database to access the table or view to which the `@dblink` reference is appended.

!!!note "Oracle compatibility"
- For EDB Postgres Advanced Server 12, the CREATE DATABASE LINK command has been tested and certified with all the minor versions for use with Oracle versions 10g Release 2, 11g Release 2, 12c Release 1, 18c Release 1, 19c, and 23.
- For EDB Postgres Advanced Server 12, the CREATE DATABASE LINK command has been tested and certified with all the minor versions for use with Oracle versions 10g Release 2, 11g Release 2, 12c Release 1, 18c Release 1, 19c, 21c, and 23.
!!!

!!!note
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ When the `CREATE DATABASE LINK` command is given, the database link name and the
A SQL command containing a reference to a database link must be issued while connected to the local database. When the SQL command is executed, the appropriate authentication and connection is made to the remote database to access the table or view to which the `@dblink` reference is appended.

!!!note "Oracle compatibility"
- For EDB Postgres Advanced Server 13, the CREATE DATABASE LINK command has been tested and certified with all the minor versions for use with Oracle versions 10g Release 2, 11g Release 2, 12c Release 1, 18c Release 1, 19c, and 23.
- For EDB Postgres Advanced Server 13, the CREATE DATABASE LINK command has been tested and certified with all the minor versions for use with Oracle versions 10g Release 2, 11g Release 2, 12c Release 1, 18c Release 1, 19c, 21c, and 23.
!!!

!!!note
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ When you use the `CREATE DATABASE LINK` command, the database link name and the
You must be connected to the local database when you issue a SQL command containing a reference to a database link. When the SQL command executes, the appropriate authentication and connection is made to the remote database to access the table or view to which the `@dblink` reference is appended.

!!!note "Oracle compatibility"
- For EDB Postgres Advanced Server 14, the CREATE DATABASE LINK command has been tested and certified with all the minor versions for use with Oracle versions 10g Release 2, 11g Release 2, 12c Release 1, 18c Release 1, 19c, and 23.
- For EDB Postgres Advanced Server 14, the CREATE DATABASE LINK command has been tested and certified with all the minor versions for use with Oracle versions 10g Release 2, 11g Release 2, 12c Release 1, 18c Release 1, 19c, 21c, and 23.
!!!

!!!note
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "pgsnmpd"
<div id="pgsnmpd" class="registered_link"></div>

!!! Note
'pgsnnmpd' is deprecated as of EDB Postgres Advanced Server v14. It isn't included in EDB Postgres Advanced Server v15 and later.
'pgsnnmpd' is deprecated as of EDB Postgres Advanced Server v14. It isn't included in EDB Postgres Advanced Server v15 and later. We recommend using Postgres Enterprise Manager and its [built-in interfaces for SNMP](/pem/latest/monitoring_performance/notifications/) for monitoring needs.

`pgsnmpd` is an SNMP agent that can return hierarchical information about the current state of EDB Postgres Advanced Server on a Linux system. `pgsnmpd` is distributed and installed using the `edb-asxx-pgsnmpd` RPM package, where `xx` is the EDB Postgres Advanced Server version number. The `pgsnmpd` agent can operate as a standalone SNMP agent, as a pass-through subagent, or as an AgentX subagent.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ When you use the `CREATE DATABASE LINK` command, the database link name and the
You must be connected to the local database when you issue a SQL command containing a reference to a database link. When the SQL command executes, the appropriate authentication and connection is made to the remote database to access the table or view to which the `@dblink` reference is appended.

!!!note "Oracle compatibility"
- For EDB Postgres Advanced Server 15, the CREATE DATABASE LINK command has been tested and certified with all the minor versions for use with Oracle versions 10g Release 2, 11g Release 2, 12c Release 1, 18c Release 1, 19c, and 23.
- For EDB Postgres Advanced Server 15, the CREATE DATABASE LINK command has been tested and certified with all the minor versions for use with Oracle versions 10g Release 2, 11g Release 2, 12c Release 1, 18c Release 1, 19c, 21c, and 23.
!!!

!!!note
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ When you use the `CREATE DATABASE LINK` command, the database link name and the
You must be connected to the local database when you issue a SQL command containing a reference to a database link. When the SQL command executes, the appropriate authentication and connection is made to the remote database to access the table or view to which the `@dblink` reference is appended.

!!!note "Oracle compatibility"
- For EDB Postgres Advanced Server 16, the CREATE DATABASE LINK command has been tested and certified with all the minor versions for use with Oracle versions 10g Release 2, 11g Release 2, 12c Release 1, 18c Release 1, 19c, and 23.
- For EDB Postgres Advanced Server 16, the CREATE DATABASE LINK command has been tested and certified with all the minor versions for use with Oracle versions 10g Release 2, 11g Release 2, 12c Release 1, 18c Release 1, 19c, 21c, and 23.
!!!

!!!note
Expand Down
Loading

2 comments on commit 6a15cb7

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸŽ‰ Published on https://edb-docs.netlify.app as production
πŸš€ Deployed on https://66fa6d26e4c5dd20ea2b0746--edb-docs.netlify.app

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.