Skip to content

Commit

Permalink
Merge branch 'main' into dprice-bemi-guide
Browse files Browse the repository at this point in the history
  • Loading branch information
danieltprice committed Jun 15, 2024
2 parents 7356fc6 + c2c73a6 commit e590aed
Show file tree
Hide file tree
Showing 1,619 changed files with 37,926 additions and 31,494 deletions.
54 changes: 54 additions & 0 deletions .github/workflows/format-markdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Format Markdown

on:
push:
branches:
- '**'
paths:
- 'content/**/*.md'

jobs:
format-markdown:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 2
token: ${{ secrets.ACCESS_TOKEN }}

- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: 18

- name: Install Prettier
run: npm install prettier

- name: Run Prettier
run: npx prettier --write "content/**/*.md" --ignore-path .prettierignore

- name: Commit changes
run: |
git config user.name "GitHub Action"
git config user.email "[email protected]"
export HUSKY=0
git add -A
# Check for meaningful changes before committing
if [ -n "$(git status --porcelain)" ]; then
# Commit only modified markdown files, not all changes
git commit -m "chore: format content markdown files with Prettier"
echo "Changes committed"
else
echo "No significant changes to commit"
exit 0
fi
- name: Pull latest changes
run: git pull --rebase

- name: Push changes
run: git push
env:
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
3 changes: 3 additions & 0 deletions .github/workflows/update-frontmatter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ jobs:
exit 0
fi
- name: Pull latest changes
run: git pull --rebase

- name: Push changes
run: git push origin HEAD:main
env:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,4 @@ public/md

content/docs/guides/time_travel_tutorial_before-1.png
yarn.lock
package-lock.json
7 changes: 6 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,9 @@
package.json
package-lock.json
public/
content/

# content files
content/docs/community/contribution-guide.md
content/docs/postgresql/query-reference.md
content/docs/functions/json_extract_path.md
content/docs/introduction/monitoring-page.md
2 changes: 1 addition & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"jsxSingleQuote": false,
"trailingComma": "es5",
"bracketSpacing": true,
"jsxBracketSameLine": false,
"bracketSameLine": false,
"arrowParens": "always",
"endOfLine": "lf"
}
6 changes: 3 additions & 3 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/content/docs/ @danieltprice
/src/ @andrewgolovanov @k8isdead
_.js @andrewgolovanov @k8isdead
_.jsx @andrewgolovanov @k8isdead
/src/ @andrewgolovanov @americano98
_.js @andrewgolovanov @americano98
_.jsx @andrewgolovanov @americano98
2 changes: 1 addition & 1 deletion content/changelog/2022-08-02.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ redirectFrom:

### Fixes & improvements

- Compute: Installed the `uuid-ossp` extension binaries, which provide functions for generating universally unique identifiers (UUIDs). `CREATE EXTENSION "uuid-ossp"` is now supported. For information about extensions supported by Neon, see [Available Postgres extensions](/docs/extensions/pg-extensions).
- Compute: Installed the `uuid-ossp` extension binaries, which provide functions for generating universally unique identifiers (UUIDs). `CREATE EXTENSION "uuid-ossp"` is now supported. For information about extensions supported by Neon, see [Available Postgres extensions](/docs/extensions/pg-extensions).
- Compute: Added logging for compute node initialization failure during the 'basebackup' stage.
- Pageserver: Avoided busy looping when deletion from cloud storage is skipped due to failed upload tasks.
- Pageserver: Merged the 'wal_receiver' endpoint with 'timeline_detail', in the internal management API.
Expand Down
2 changes: 1 addition & 1 deletion content/changelog/2022-10-25.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ redirectFrom:
### Fixes & improvements

- Compute: Added support for Postgres 15.0 and its Postgres extensions.
For information about supported extensions, see [Available Postgres extensions](/docs/extensions/pg-extensions).
For information about supported extensions, see [Available Postgres extensions](/docs/extensions/pg-extensions).
- Compute: Disabled the `wal_log_hints` parameter, which is the default Postgres setting. The Pageserver-related issue that required enabling `wal_log_hints` has been addressed, and enabling `wal_log_hints` is no longer necessary.
- Pageserver: Added a timeline `state` field to the `TimelineInfo` struct that is returned by the `timelines` internal management API endpoint. Timeline `state` information improves observability and communication between Pageserver modules.
2 changes: 1 addition & 1 deletion content/changelog/2022-11-04.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Updated Neon's branching capabilities. The following enhancements were introduce

For more information about Neon's branching capabilities, see [Branching](/docs/introduction/branching), and [Manage branches](/docs/manage/branches).

_Neon Branching capabilities are not yet publicly available. If you would like to try this feature, contact us at [[email protected]](mailto:[email protected]), describing your use case and requesting that Neon enable branching for your account._
_Neon Branching capabilities are not yet publicly available. If you would like to try this feature, contact us at [[email protected]](mailto:[email protected]), describing your use case and requesting that Neon enable branching for your account._

### Connection string changes

Expand Down
2 changes: 1 addition & 1 deletion content/changelog/2022-11-17.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ redirectFrom:
- Control Plane: Improved diagnostic information by extracting error messages from Pageserver responses during project creation.
- Control Plane: Stopped manually rolling back the current transaction when the user cancels the context. The Go driver [ConnBeginTx](https://pkg.go.dev/database/sql/driver#ConnBeginTx) interface performs this operation automatically.
- UI: Postgres 15 is now the default version when creating a Neon project.
- UI: Added support for renaming branches. To rename a branch, select the branch on the **Branches** page in the Neon Console and click **Rename branch**.
- UI: Added support for renaming branches. To rename a branch, select the branch on the **Branches** page in the Neon Console and click **Rename branch**.
- UI: Added `TIME` and `LSN` fields to the branch details page for child branches. The `TIME` field shows the time value selected when creating a branch with data up to a specified point in time. The `LSN` field shows a Log Sequence Number (LSN), indicating that the branch was created with data up to that LSN.
- UI: Added a branch icon to the branch selection menu on the **Databases** and **Users** pages in the Neon Console.
- UI: Added badges for various elements on the branch details page in the Neon Console.
Expand Down
4 changes: 2 additions & 2 deletions content/changelog/2022-12-28.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ redirectFrom:
- API: Added the ability to delete or reassign the endpoint associated with a project's root branch. Previously, these actions could not be performed on the endpoint associated with a project's root branch. You can edit or delete an endpoint by selecting **Edit** or **Delete** from the kebab menu in the table on the **Endpoints** page.
- API: Updated descriptions and examples in the [Neon API v2 reference](https://api-docs.neon.tech/reference/getting-started-with-neon-api).
- API: Added validation to ensure that the name specified when creating a role does not exceed 63 bytes. Role names longer than 63 bytes caused compute startup issues.
- Control Plane: Migrated older branches that were created using the Neon API v1 to their parent project. Branches created with Neon API v1 existed as separate Neon projects. After the migration, the branches exist as Neon API v2 branch and endpoint objects that belong to a parent project. Connection strings for migrated branches, which use the old `project_id` in the hostname, are no longer valid. Instead of the `project_id`, an `endpoint_id` must be specified in the hostname. For information about constructing a valid connection string, see [Connect from any application](/docs/connect/connect-from-any-app/). An email with migration instructions was sent to affected users.
- UI: Added a **Pooler enabled** toggle control to the **Edit endpoint** dialog to permit enabling or disabling connection pooling for endpoint compute instances. The same control is available on the **Create endpoint** dialog. Previously, connection pooling was enabled or disabled for a project, and the control was located in **Settings > General**. Connection pooling is disabled, by default. For more information about Neon's connection pooling feature, see [Connection pooling](/docs/connect/connection-pooling/).
- Control Plane: Migrated older branches that were created using the Neon API v1 to their parent project. Branches created with Neon API v1 existed as separate Neon projects. After the migration, the branches exist as Neon API v2 branch and endpoint objects that belong to a parent project. Connection strings for migrated branches, which use the old `project_id` in the hostname, are no longer valid. Instead of the `project_id`, an `endpoint_id` must be specified in the hostname. For information about constructing a valid connection string, see [Connect from any application](/docs/connect/connect-from-any-app/). An email with migration instructions was sent to affected users.
- UI: Added a **Pooler enabled** toggle control to the **Edit endpoint** dialog to permit enabling or disabling connection pooling for endpoint compute instances. The same control is available on the **Create endpoint** dialog. Previously, connection pooling was enabled or disabled for a project, and the control was located in **Settings > General**. Connection pooling is disabled, by default. For more information about Neon's connection pooling feature, see [Connection pooling](/docs/connect/connection-pooling/).
- UI: Completed the migration of the Neon Console from Neon API v1 to [Neon API v2](https://api-docs.neon.tech/reference/getting-started-with-neon-api). The Neon API v1 is deprecated.
- UI: Added a **Region** column to the **Projects** dialog in the Neon Console to show the region where a Neon project resides.
- UI: Improved WebSockets integration with the Neon Console, and added Websocket support for endpoint updates.
Expand Down
2 changes: 1 addition & 1 deletion content/changelog/2023-01-17.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Added support for several Postgres extensions. Newly supported extensions includ
- `earthdistance`
- `address_standardizer`
- `address_standardizer_data_us`

For more information about Postgres extensions supported by Neon, see [Postgres extensions](/docs/extensions/pg-extensions).

### Fixes & improvements
Expand Down
4 changes: 2 additions & 2 deletions content/changelog/2023-02-02.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ redirectFrom:
- API: The response body for projects, branches, and endpoints now exposes a `creation_source` property. Currently, the `creation_source` property identifies the `console` as the creation source in all cases but will eventually identify other sources, such as the Neon API.
- API: Listing projects with the Neon API now supports cursor-based pagination. Pagination enables limiting the number of responses displayed at one time, which is useful when a response includes a large number of projects. By default, the first 10 projects are returned. You can set the `limit` parameter to request up to 100 projects.
- API: Fixed a race condition that occurred when creating a project and attempting to fetch information about branch in the same project.
- Control Plane: Added support for OpenTelemetry for a number of operations. OpenTelemetry is an observability framework that assists in generating and capturing telemetry data from cloud-native software.
- Control Plane: Added support for OpenTelemetry for a number of operations. OpenTelemetry is an observability framework that assists in generating and capturing telemetry data from cloud-native software.
- Control Plane: Removed the `stop_compute` operation, which is no longer used. It was replaced by `suspend_compute`.
- Control Plane: Fixed a `cannot execute GRANT in a read-only` error that occurred when a database owner enabled the `default_transaction_read_only` setting, preventing the Control Plane from configuring the compute instance.
- UI: Revised the layout of the Neon Console to improve navigation. The following enhancements were implemented:
- A new sidebar with icons replaces the navigation bar that was located at the top of the console.
- **Operations**, **Databases**, and **Users** pages, previously accessed from the **Project settings** page, are now directly accessible from the sidebar.
- Links to **Community**, **Feedback**, **Docs**, **Release notes**, and **Support**, previously located in a **Help** menu in the navigation bar, were moved to the sidebar for easier access.
- The Neon account avatar was moved from the top right corner of the console to the sidebar.
- UI: Fixed the positioning of selection menus in the console to avoid scrolling outside intended boundaries.
- UI: Fixed the positioning of selection menus in the console to avoid scrolling outside intended boundaries.
2 changes: 1 addition & 1 deletion content/changelog/2023-02-06.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ redirectFrom:
postgres://alex:[email protected]/dbname
```

Connections that do not specify the `-pooler` suffix connect to the database directly. The ability to enable pooling for individual connections supports workflows that require both pooled and non-pooled connections to the same database. For example, serverless applications that use Prisma Client require a pooled connection, while Prisma Migrate requires a direct connection to the database. For more information, see [Enable connection pooling](/docs/connect/connection-pooling#enable-connection-pooling).
Connections that do not specify the `-pooler` suffix connect to the database directly. The ability to enable pooling for individual connections supports workflows that require both pooled and non-pooled connections to the same database. For example, serverless applications that use Prisma Client require a pooled connection, while Prisma Migrate requires a direct connection to the database. For more information, see [How to use connection pooling](/docs/connect/connection-pooling#how-to-use-connection-pooling).

The previous method of enabling connection pooling for a compute endpoint is deprecated. When switching to the new per-connection method, be sure to disable connection pooling at the compute endpoint. You can do so by [editing the compute endpoint](/docs/manage/endpoints#edit-a-compute-endpoint).

Expand Down
2 changes: 1 addition & 1 deletion content/changelog/2023-02-10.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ redirectFrom:

### Fixes & improvements

- API: Added a `quota_reset_at` property to the `Project` response schema in the Neon API. This property displays a future date indicating when a resource consumption quota will be reset. For example, the Neon Free Tier offers 100 compute hours per month. The `quota_reset_at` property shows when that quota will be set back to 100 hours.
- API: Added a `quota_reset_at` property to the `Project` response schema in the Neon API. This property displays a future date indicating when a resource consumption quota will be reset. For example, the Neon Free Tier offers 100 compute hours per month. The `quota_reset_at` property shows when that quota will be set back to 100 hours.
- API: Added a `compute_seconds_limit` property to the `CurrentUserInfoResponse` schema in the Neon API. This property defines the monthly compute limit in terms of compute seconds.
- Integrations: The [Neon integration with Vercel](https://vercel.com/integrations/neon) did not create branches for preview deployments when the Vercel user ID differed from the one specified when adding the Neon integration to Vercel. This issue was encountered when using the Neon integration from a [Vercel Teams](https://vercel.com/docs/teams-and-accounts/create-or-join-a-team) account.
3 changes: 2 additions & 1 deletion content/changelog/2023-02-21.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ redirectFrom:

- Compute: Added support for the Postgres `xml2` and `pgjwt` extensions. For more information about Postgres extensions supported by Neon, see [Postgres extensions](/docs/extensions/pg-extensions).
- Compute: Updated the versions for the following Postgres extensions:

- Updated the `address_standardizer`, `address_standardizer_data_us`, `postgis`, `postgis_raster`, `postgis_tiger_geocoder`, `postgis_topology` extensions to version `3.3.2`.
- Updated the `plv8`, `plls`, `plcoffee` extensions to `3.1.5`.
- Updated the `h3_pg` extension to `4.1.2`.
Expand All @@ -19,4 +20,4 @@ redirectFrom:

- Pageserver: Corrected the storage size metrics calculation to ensure that only active branches are counted.
- Proxy: Enabled `OpenTelemetry` tracing to capture all incoming requests. This change enables Neon to perform an end-to-end trace when a new
connection is established.
connection is established.
7 changes: 4 additions & 3 deletions content/changelog/2023-02-24.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@ redirectFrom:
- Integrations: Improved text and fixed a documentation link in the [Neon Vercel Integration](https://vercel.com/integrations/neon) UI.
- UI: The [Neon Free Tier](/docs/introduction/free-tier) now includes a compute endpoint with each branch. Previously, there was a limit of 3 endpoints per project. This limit was removed based on user feedback indicating that it was not conducive to developer workflows that create a branch for each preview deployment.

Instead of limiting the number of endpoint computes in the Neon Free Tier, there is now a limit of 100 compute active time hours per month. Currently, the compute hour limit applies to newly created projects only. The limit does not yet apply to existing projects. We expect to apply the limit to all projects later this quarter. Regardless of the compute hour limit, you are always able to connect to the compute endpoint associated with the primary branch of your Neon project. For more information, see [Free Tier](/docs/introduction/free-tier).
Instead of limiting the number of endpoint computes in the Neon Free Tier, there is now a limit of 100 compute active time hours per month. Currently, the compute hour limit applies to newly created projects only. The limit does not yet apply to existing projects. We expect to apply the limit to all projects later this quarter. Regardless of the compute hour limit, you are always able to connect to the compute endpoint associated with the primary branch of your Neon project. For more information, see [Free Tier](/docs/introduction/free-tier).

If you have any questions about how this change to Neon's Free Tier limits might impact your existing project, please reach out to us on our [Discord Server](https://discord.gg/92vNTzKDGp).

If you have any questions about how this change to Neon's Free Tier limits might impact your existing project, please reach out to us on our [Discord Server](https://discord.gg/92vNTzKDGp).
- UI: With the removal of the endpoint limit, endpoints no longer appear in the **Project limits** widget on the Neon **Dashboard**.
- UI: With the introduction of pooled connections strings (see [Enable pooling](/docs/connect/connection-pooling#enable-connection-pooling)), enabling pooling for a compute endpoint is deprecated. With this change, the **Pooler enabled** toggle on the **Edit Compute Endpoint** dialog is now disabled and will be removed in a future release.
- UI: With the introduction of pooled connections strings (see [How to use connection pooling](/docs/connect/connection-pooling#how-to-use-connection-pooling)), enabling pooling for a compute endpoint is deprecated. With this change, the **Pooler enabled** toggle on the **Edit Compute Endpoint** dialog is now disabled and will be removed in a future release.
- UI: Changed a column heading in the table on the **Operations** page from **ID** to **Action**. The items listed in the column are operation actions rather than IDs.
- UI: Renamed the **Users** page in the Neon Console to **Roles**. This change aligns Neon's terminology with Postgres, which uses the concept of "roles" to refer to database users. (See [Database roles](https://www.postgresql.org/docs/current/user-manag.html), in the _PostgreSQL documentation_.) All UI elements in the Neon Console were updated to reflect this change.
Loading

0 comments on commit e590aed

Please sign in to comment.