diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx new file mode 100644 index 00000000000..9d24b968057 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_dbeaver.mdx @@ -0,0 +1,41 @@ +--- +title: "Connect to your cluster using DBeaver" +navTitle: DBeaver +indexCards: none +--- + +!!! Note + All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page and then selecting the **Connect** tab. + +1. Launch [DBeaver](https://dbeaver.io/). +2. Select the **New Database Connection** button on the toolbar to open the **Connect to a database** dialog. +3. Select **PostgreSQL** and select **Next**. + + You might be prompted to download the PostgreSQL JDBC driver. +4. On the **Main** tab: + + - Enter your cluster's hostname in the **Host** field. + + - Enter `edb_admin` in the **Database** field. + - Enter `edb_admin` in the **Username** field. + - Enter your cluster's password in the **Password** field. + +5. On the **SSL** tab: + + - Select the **Use SSL** check box. + - Select **require** for the **SSL mode:** field. + +6. On the **PostgreSQL** tab, check the **Show all databases** check box. + +7. Select the **Test connection** button and verify that DBeaver can connect to your cluster. +8. Select **Finish** to save the connection. + + +## Next steps + +[Experiment!](../experiment) + + +## Further reading + +[Connecting to your cluster](/biganimal/latest/using_cluster/02_connecting_your_cluster/) in the full version documentation. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx new file mode 100644 index 00000000000..061aead708e --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_pgadmin.mdx @@ -0,0 +1,33 @@ +--- +title: "Connect to your cluster using pgAdmin" +navTitle: pgAdmin +indexCards: none +--- + +!!! Note + All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page and then selecting the **Connect** tab. + + +[The pgAdmin project](https://www.pgadmin.org/download/) allows you to inspect, monitor, manage, and query your cluster's databases from a desktop or web UI. + +From the welcome page, select **Add New Server**. You'll be prompted to configure the connection. + +Enter `BigAnimal Trial` for the name (or use the name you gave to your cluster!), and then select **Connection**. + +1. Enter your cluster's hostname in the **Host name/address** field. +2. Enter `edb_admin` in the **Maintenance database** field (this is the default database that'll be connected to by pgAdmin). +3. Enter `edb_admin` in the **Username** field. +4. Enter the password you provided when configuring your cluster in the **Password** field (you might want to save this for convenience while testing). + +Select **SSL** and change SSL mode to **Require**. + +Finally, select the **Save** button. pgAdmin tries to establish a connection to your database. When successful, it displays the dashboard +along with the list of available databases on the left. + +## Next steps + +[Experiment!](../experiment) + +## Further reading + +[Connecting to your cluster](/biganimal/latest/using_cluster/02_connecting_your_cluster/) in the full version documentation. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx new file mode 100644 index 00000000000..4c042193e6b --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/connect_using_psql.mdx @@ -0,0 +1,36 @@ +--- +title: "Connect to your cluster using psql" +navTitle: psql +indexCards: none +--- + +!!! Note + All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page and then selecting the **Connect** tab. + + +[psql](https://www.postgresql.org/docs/current/app-psql.html) is the standard PostgreSQL [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) +and an all-around useful tool for working with PostgreSQL databases. In addition to letting you submit SQL and view the results, it offers quite a few built-in commands for +inspecting and managing the database that make light work of even complex tasks. + +You can find an example of connecting to a BigAnimal cluster via psql right on your cluster's **Overview** tab on the portal. For example: + +```shell +psql -W "postgres://edb_admin@p-xxxxxxxxxxx.pg.biganimal.io:5432/edb_admin?sslmode=require" +``` + +The URI is all that's necessary for psql. While you _can_ pass each element of that URL individually +(pulling the information from the **Connect** tab on the portal, for instance), psql will happily parse it out for you (and prompt for the password). + +In case you're unfamiliar with PostgreSQL's URI format, you can find it documented [on postgresql.org](https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6). + + +!!! Note EDB Postgres Advanced Server enhancements + If your cluster is running EDB Postgres Advanced Server, you might wish to install the version of psql that ships with it; there are a few nice additions such as tab completion for Oracle database-compatible syntax. However, the standard PostgreSQL client works with EDB Postgres Advanced Server as well. + +## Next steps + +[Experiment!](../experiment) + +## Further reading + +[Connecting to your cluster](/biganimal/latest/using_cluster/02_connecting_your_cluster/) in the full version documentation. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx new file mode 100644 index 00000000000..d40aa5077ac --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/detail/connect_to_a_cluster/index.mdx @@ -0,0 +1,18 @@ +--- +title: "Connect to your cluster" +description: "Connecting to a BigAnimal cluster from several common clients" +indexCards: simple +navigation: + - connect_using_psql + - connect_using_pgadmin + - connect_using_dbeaver +--- + +So, you've created a cluster. Now what? You probably want to connect to it! + +BigAnimal clusters are real, actual Postgres databases, so you can connect to them just as you would any other Postgres database. + +All of the parameters you need to connect can be found on the portal by selecting the name of your cluster on the [Clusters](https://portal.biganimal.com/clusters) page and then selecting the **Connect** tab. + +This section provides a few examples of connecting from common clients. + diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx new file mode 100644 index 00000000000..3fdb78d2d7d --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_cli.mdx @@ -0,0 +1,147 @@ +--- +title: Creating a cluster on the command line +navTitle: "Using the command line" +indexCards: none +--- + + +We'll be using the [BigAnimal command line interface](/biganimal/latest/reference/cli/), which is a convenient wrapper to the [BigAnimal API](/biganimal/latest/reference/api/). To start, download [the latest binary](/biganimal/latest/reference/cli/) and move it to wherever your system finds executable files (somewhere on your PATH). + +!!! Note Linux and MacOS note + If you're on a Linux or MacOS system, you'll need to mark the `biganimal` file as executable by + running `chmod +x [/path/to/biganimal]` before you can use it. + + +Next, you need to create a credential on BigAnimal. You can pick any username you prefer. + +```shell +biganimal create-credential -a portal.biganimal.com -o 443 -n newuser +__OUTPUT__ +First, copy your one-time code: + CODE-CODE +Then visit: https://auth.biganimal.com/activate +press [Enter] to continue in the web browser... + +Credential "newuser" is created operation succeeded +Switched the context credential to "newuser". +``` + +!!! Note Linux dependencies + The BigAnimal CLI uses the xdg-open utility to open a browser on Linux systems. + On minimal systems, you may need to install this dependency before creating a credential. + +The command will direct you to open a webpage and copy the randomly generated, one-time code. You’ll need to log in (or already be logged in) to activate the credentials. You can see the credentials you've verified on the command line. + +```shell +biganimal show-credentials +__OUTPUT__ +┌──────────────────────────────────────────────────────┐ +│ Credentials │ +├─────────┬─────────────────────────────────────┬──────┤ +│ name │ address │ port │ +├─────────┼─────────────────────────────────────┼──────┤ +│ newuser │ portal.biganimal.com │ 443 │ +└─────────┴─────────────────────────────────────┴──────┘ +``` + +!!! caution +If you add another credential, you’ll need to add `--credential [newuser]` to the following commands. If you only have one, the option isn't needed. You can change the default credential using `biganimal config set context_credential [name]` You can remove unneeded credentials using `biganimal delete-credential [olduser]`. Most users don't need to add multiple credentials. +!!! + +In the free trial, the range of cluster options is somewhat limited but should be more than sufficient for demonstrating the capabilities of BigAnimal. + +Pick the region closest to you from the list provided by BigAnimal: + +```shell +biganimal show-regions +__OUTPUT__ +Use the arrow keys to navigate: ↓ ↑ +Provider ID? + AWS + ▸ Azure +┌───────────────────────────────────┐ +│ Regions │ +├────────────┬──────────────────────┤ +│ Region Id │ Region Name │ +├────────────┼──────────────────────┤ +│ eastus2 │ (US) East US 2 │ +│ westeurope │ (Europe) West Europe │ +└────────────┴──────────────────────┘ +``` + +Other options can be queried via the CLI, but the only value we need to set for this demo is the region Id. + +Edit a new file called `create_cluster.yaml`: + +```yaml +clusterName: test_cluster # Pick a more meaningful name! +password: mygoodpassword # Please change this password! +postgresType: epas +postgresVersion: "14" +provider: azure +region: eastus2 # Select from the options given by show-regions +instanceType: azure:Standard_E2s_v3 +volumeProperties: P1 +volumeType: azurepremiumstorage +networking: public +highAvailability: false +``` + +Use the config file to create a new cluster: + +```shell +biganimal create-cluster --clusterConfigFile create_cluster.yaml +__OUTPUT__ +Are you sure you want to create cluster "test_cluster"? [y|n]: y +Create Cluster operation is started +Cluster ID is "p-xxxxxxxxxx" +To check current state, run: biganimal show-clusters --id p-xxxxxxxxxx +``` + +If successful, create-cluster will give you the ID of your new cluster (you'll use this to manage it) as well as +the command you can use to check the status of your new cluster: + +```shell +biganimal show-clusters --id p-xxxxxxxxxx +__OUTPUT__ +┌──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│ Clusters │ +├──────────────┬──────────────┬───────────────────────────────────┬──────────┬────────────────┬───────────────┬──────────────────────────────┬─────────┤ +│ ID │ Name │ Status │ Provider │ Region │ Instance Type │ Postgres Type │ Version │ +├──────────────┼──────────────┼───────────────────────────────────┼──────────┼────────────────┼───────────────┼──────────────────────────────┼─────────┤ +│ p-xxxxxxxxxx │ test_cluster │ Cluster creation request received │ Azure │ (US) East US 2 │ E2s v3 │ EDB Postgres Advanced Server │ 14 │ +└──────────────┴──────────────┴───────────────────────────────────┴──────────┴────────────────┴───────────────┴──────────────────────────────┴─────────┘ +``` + +It might take a few minutes to create your cluster. When it’s ready, +the Status column will change to "Cluster in healthy state". + +In the meantime, you can get the connection string for your cluster: + +```shell +biganimal show-cluster-connection --id p-xxxxxxxxxxx +__OUTPUT__ +┌──────────────────────────────────────────────────────────────────────────────────────────┐ +│ Connection String │ +├──────────────────────────────────────────────────────────────────────────────────────────┤ +│ postgres://edb_admin@p-xxxxxxxxxxx.pg.biganimal.io:5432/edb_admin?sslmode=require │ +└──────────────────────────────────────────────────────────────────────────────────────────┘ +``` + +Once the cluster is created, log in via psql. Use the password from the `config` file for edb_admin. + +```shell +psql 'postgres://edb_admin@p-xxxxxxxxxx.pg.biganimal.io:5432/edb_admin?sslmode=require' +``` + +!!! Note "Other options for connecting" + Sure, psql is great, but maybe you want to use another client. See [Connect to your cluster](../connect_to_a_cluster) for other options. + +## Next steps + +[Connect to your cluster](../connect_to_a_cluster) + +## Further reading + +[BigAnimal CLI reference](/biganimal/latest/reference/cli/) and +[Creating a cluster](/biganimal/latest/getting_started/creating_a_cluster/) in the full version documentation. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx new file mode 100644 index 00000000000..ffb521ab2dd --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/create_cluster_portal.mdx @@ -0,0 +1,64 @@ +--- +title: Creating a cluster using the web portal +navTitle: "Using the portal" +indexCards: none +--- + +## Navigating to the Create Cluster page + +1. Navigate to the [BigAnimal portal](https://portal.biganimal.com/). (Sign in with [your account](../create_account) if you need to). + +2. Select the **Clusters** link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page. + +3. Select the **Create New Cluster** button. + +You should now find yourself at the [Create Cluster page](https://portal.biganimal.com/create-cluster). + +## Configuring a new cluster + +### The Cluster Settings tab + +In the free trial, the range of cluster options is somewhat limited but should be more than sufficient for demonstrating the capabilities of BigAnimal. + +1. Use **Cluster Name** to describe the purpose of the cluster. For example, "Test for Advanced Server on AWS." +2. **Password** is the admin password for the cluster, so pick a strong one! Note that this is independent of your EDB account. +3. **Database Type** is one of: + + - **EnterpriseDB PostgreSQL Advanced Server** for Oracle database compatibility + - **PostgreSQL** for official community builds of standard PostgreSQL + + So if you're interested in EDB's enhancements to PostgreSQL for Oracle database compatibility, choose Advanced Server; otherwise, choose PostgreSQL. +4. **Postgres Version** allows you to select from among the supported versions for either database type. +4. **Provider** is either AWS or Azure; BigAnimal works the same on either one, so choose the one you're familiar with. +5. **Region** options depend on the provider you chose; pick the one closest to you. +6. **Network Connectivity** is restricted to a public IP for the trial, but you can restrict access to trusted networks by + selecting the **Use allowlists to restrict network access** check box and specifying one or more [CIDR blocks](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + to allow access from. + +For **Instance Type** and **Storage**, only one option is available for each field during the trial, so just choose that. + +### The DB Configuration tab + +This is entirely optional, but if you're curious, you can find a full set of PostgreSQL configuration options on this tab, allowing you to tune a cluster for specific needs or resource constraints. + +### The Availability tab + +This page configures high availability, but that feature isn't available in the trial. Skip this tab unless you're curious. + +## Provisioning + +Select **Create Cluster**, and you're brought back to the Clusters page with your newly configured cluster now populating the list. + +Initially, the new cluster is being provisioned. This usually takes a minute or two but can take up to an hour. A progress bar is shown near the right. + +Once your first cluster is fully provisioned, your 14-day free trial officially starts, and a countdown appears telling you how many days are left in your trial. + +Select the provisioned cluster to view the parameters you'll need to connect to it. + +## Next steps + +[Connect to your cluster](../connect_to_a_cluster) + +## Further reading + +[Creating a cluster](/biganimal/latest/getting_started/creating_a_cluster/) in the full version documentation. \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx new file mode 100644 index 00000000000..f422fc47cf6 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_a_cluster/index.mdx @@ -0,0 +1,19 @@ +--- +title: "Create a cluster" +description: "Creating a BigAnimal cluster from the portal or the command line" +indexCards: none +--- + +The BigAnimal free trial allows one active cluster. If you want to try another configuration, you'll need to delete your active cluster. Thankfully, it's also quick and easy to [restore your deleted cluster from a backup](../experiment/backup_and_restore/) if you need to later on. Backups are automatically created as soon as a cluster is used. + +When you create a cluster, there are two flavors of PostgreSQL to choose from: + +- All supported versions of [open-source PostgreSQL](supported-open-source/postgresql/), including [PostgreSQL 14](https://www.postgresql.org/about/news/postgresql-14-released-2318/). +- [EDB Postgres Advanced Server](/epas/latest/), which augments open-source PostgreSQL with [Oracle compatibility](/epas/latest/epas_compat_ora_dev_guide/), among other features. + +We'll demonstrate two methods of creating a cluster: + +- [Using the portal](create_cluster_portal) +- [Using the command line](create_cluster_cli) + +Clusters can also be created programmatically using the [fully featured BigAnimal API](/biganimal/latest/reference/api/). diff --git a/product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx new file mode 100644 index 00000000000..c7331608175 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/detail/create_an_account/index.mdx @@ -0,0 +1,20 @@ +--- +title: "Create an EDB account for your free trial" +description: "Creating an EDB account and signing into the BigAnimal free trial portal" +navTitle: "Create an account" +--- + +Registering an account on [enterprisedb.com](https://www.enterprisedb.com/) gets you access to the BigAnimal trial, as well as EDB's training and software downloads. +Accounts are free, and registration takes less than a minute. + +1. Navigate to <https://biganimal.com>. +2. Select the **Try it for free** button. +3. Fill in the form, and agree to the terms and conditions. +4. Select **Submit**. +5. Check your email. You should receive an email from EDB containing an activation link. +6. Select the activation link and enter a password for your EDB account. + +You're then redirected to the BigAnimal portal. + +!!! Note "Already have an EDB account?" + If you've already signed up for an EDB account, you can navigate to <https://portal.biganimal.com/> to log in. diff --git a/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx new file mode 100644 index 00000000000..ee38df0e011 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/backup_and_restore.mdx @@ -0,0 +1,166 @@ +--- +title: Back up and restore a cluster +navTitle: "Backup and restore" +indexCards: none +--- + +BigAnimal [automatically and continuously](/biganimal/latest/using_cluster/04_backup_and_restore/) saves backups of your clusters. You can restore your cluster to any point in the past after the initial backup on cluster creation. That functionality is included in the free trial as well. While that means you don't have to do anything to generate backups, it's always sensible to test your backups. + +If you haven't already, [create a cluster](../create_a_cluster/create_cluster_cli) on BigAnimal. For the free trial, you can have only one active cluster. Since this is a demonstration of recovering a cluster from backup, it doesn't matter whether you start a new cluster or just restore your current cluster to its current state. + +We're going to [add a database](/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application) called "baseball," which we will populate with some Major League Baseball statistics. + +```sql +create user baseball with password 'baseball_pwd'; +grant baseball to edb_admin; +create database baseball with owner baseball; +``` + +Now you can switch to your new (and empty) baseball database. + +```sql +\c baseball +``` + +Normally we'd use log files to determine the moment in time that we want to restore. The free trial doesn't provide access to the logs, however. So that we have accurate timing of our activities, let's change the prompt to include a timestamp. For convenience, we'll use the (almost) ISO-8601 format that the restore command accepts. + +```sql +\set PROMPT1 '%`date +"%Y-%m-%dT%H:%M:%S%z"` %/%R%# ' +``` + +For this demonstration, we're just going to import batter data from the [Baseball Databank](https://github.com/chadwickbureau/baseballdatabank), which is in CSV form. While it's easy to import the data using [PostgreSQL's COPY command](https://www.postgresql.org/docs/current/sql-copy.html), we'll need to first define a table to put that data into. Most of the columns are integers, but there are a few strings to consider as well. You can just copy and paste this command into your terminal. + +```sql +CREATE TABLE batters ( + id SERIAL, + playerid VARCHAR(9), + yearid INTEGER, + stint INTEGER, + teamid VARCHAR(3), + lgid VARCHAR(2), + g INTEGER, + ab INTEGER, + r INTEGER, + h INTEGER, + "2b" INTEGER, + "3b" INTEGER, + hr INTEGER, + rbi INTEGER, + sb INTEGER, + cs INTEGER, + bb INTEGER, + so INTEGER, + ibb INTEGER, + hbp INTEGER, + sh INTEGER, + sf INTEGER, + gidp INTEGER, + PRIMARY KEY (id) +); +``` + +Now we can populate the table from the internet using the most recent data. + +```sql +\COPY batters(playerid,yearid,stint,teamid,lgid,g,ab,r,h,"2b","3b",hr,rbi,sb,cs,bb,so,ibb,hbp,sh,sf,gidp) FROM PROGRAM 'curl "https://raw.githubusercontent.com/chadwickbureau/baseballdatabank/master/core/Batting.csv"' DELIMITER ',' CSV HEADER +``` + +Just to prove there's data loaded, let's look at the home run leaders for the 1998 season. + +```sql +SELECT playerid, yearid, teamid, + rank() OVER (PARTITION BY yearid ORDER BY hr desc) hr_rank, + hr +FROM batters +WHERE yearid = 1998 +ORDER BY hr_rank LIMIT 5; +``` + +Suppose someone wanted to revise history a bit. + +```sql +UPDATE batters +SET hr=0 +where playerid = 'mcgwima01' AND yearid = 1998; +``` + +Note the time so we can restore that data later. Verify the data has been changed by rerunning the 1998 home run leader query. Now, for good measure, go ahead and drop the whole table. + +```sql +DROP TABLE batters; +``` + +You can verify the table is gone by looking at the list of tables. + +```sql +\dt +``` + +For the free trial, you're limited to one active cluster. Restoring a cluster creates a brand new cluster that's initialized with the cluster backup. Quit psql (`\q`), and delete the cluster from the command line. + +!!! Note + For more on using the BigAnimal CLI, refer to [Creating a cluster on the command line](../create_a_cluster/create_cluster_cli) and the [BigAnimal CLI reference](/biganimal/latest/reference/cli/). + +```shell +./biganimal delete-cluster --id p-xxxxxxxxxxx +``` + +Restore the cluster using the timestamp before the time you dropped the table. + +```shell +biganimal restore-cluster --id p-xxxxxxxxxxx --from-deleted --restore-point 2022-03-31T02:39:40+0000 +__OUTPUT__ +✔ New Name for Restored Cluster, Leave empty to continue with source cluster data: █ +Restored Cluster Password: ************* +Region: US East 1 +Instance Type: r5.large(2vCPU, 16GB RAM) +Volume Type: General Purpose SSD (GP3) +Volume Properties: gp3 (1 Gi - 16384 Gi, 3000 IOPS, 125 MiB/s tput) +✔ Specify database configuration, for example "application_name=sample_app&array_nulls=true". Leave empty to continue with source cluster data: █ +High Availability: Keep Existing +Networking: Keep Existing +Add IP Range to allow network traffic to your cluster from the public Internet: Keep Existing +Are you sure you want to Restore Cluster ? [y|n]: y +Restore Cluster operation is started +Cluster ID is "p-yyyyyyyyyy" +To check current state, run: biganimal show-clusters --id p-yyyyyyyyyy +``` + +!!! Note Optional arguments for the CLI + We're only providing the information we have handy to the restore command: the ID of the cluster, the fact that + the cluster is deleted, and the timestamp for the restore point. The CLI will prompt for additional information + (such as the password or the region to restore to) and allow you to enter or select from a list as appropriate. + + If you know ahead of time the options you'll need, you can provide all of them via parameters, and the command + will run non-interactively. + +Check the status of the new cluster from the command line. + +```shell +./biganimal show-clusters +``` + +Once provisioning is complete, you'll want to grab the new connection information. The hostname will have changed! + +```shell +biganimal show-cluster-connection --id p-yyyyyyyyyy +``` + +Log into the new cluster. Be sure to use the new hostname, and use the edb_admin password you provided when restoring the cluster. + +Verify that the batters table was restored: + +```sql +select playerid, yearid, teamid, + rank() OVER (PARTITION BY yearid ORDER BY hr desc) hr_rank, + hr +from batters +where yearid = 1998 +order by hr_rank limit 5; +``` + + +## Further reading + +[BigAnimal CLI reference](/biganimal/latest/reference/cli/) and [Backing up and restoring](/biganimal/latest/using_cluster/04_backup_and_restore/) in the full version documentation. + diff --git a/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx new file mode 100644 index 00000000000..7b34eec728f --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/import_data.mdx @@ -0,0 +1,77 @@ +--- +title: "Import data from external sources" +navTitle: "Import data" +--- + +PostgreSQL includes a variety of ways to import data. Here, we'll show how to import a CSV file from the internet. + +!!! Caution + Be careful when loading your own data in the Trial version and avoid storing sensitive information; trial clusters + are hosted in a shared environment. + + For a more comprehensive evaluation that runs under your own cloud account, [contact our Sales team](https://www.enterprisedb.com/contact). + +For this demonstration, we're just going to import batter data from the [Baseball Databank](https://github.com/chadwickbureau/baseballdatabank), which is in CSV form. While it's easy to import the data using [PostgreSQL's COPY command](https://www.postgresql.org/docs/current/sql-copy.html), we'll need to first define a table to put that data into. + +We're going to [add a database](/biganimal/latest/using_cluster/01_postgres_access/#one-database-with-one-application) called "baseball," which we'll populate with some Major League Baseball statistics. + +```sql +create user baseball with password 'baseball_pwd'; +grant baseball to edb_admin; +create database baseball with owner baseball; +``` + +Now you can switch to your new (and empty) baseball database. + +```sql +\c baseball +``` + +You can just copy and paste this command into your terminal. + +```sql +CREATE TABLE batters ( + id SERIAL, + playerid VARCHAR(9), + yearid INTEGER, + stint INTEGER, + teamid VARCHAR(3), + lgid VARCHAR(2), + g INTEGER, + ab INTEGER, + r INTEGER, + h INTEGER, + "2b" INTEGER, + "3b" INTEGER, + hr INTEGER, + rbi INTEGER, + sb INTEGER, + cs INTEGER, + bb INTEGER, + so INTEGER, + ibb INTEGER, + hbp INTEGER, + sh INTEGER, + sf INTEGER, + gidp INTEGER, + PRIMARY KEY (id) +); +``` + +Now we can populate the table from the internet using the most recent data. + +```sql +\COPY batters(playerid,yearid,stint,teamid,lgid,g,ab,r,h,"2b","3b",hr,rbi,sb,cs,bb,so,ibb,hbp,sh,sf,gidp) FROM PROGRAM 'curl "https://raw.githubusercontent.com/chadwickbureau/baseballdatabank/master/core/Batting.csv"' DELIMITER ',' CSV HEADER +``` + +Just to prove there's data loaded, let's look at the home run leaders for the 1998 season. + +```sql +SELECT playerid, yearid, teamid, + rank() OVER (PARTITION BY yearid ORDER BY hr desc) hr_rank, + hr +FROM batters +WHERE yearid = 1998 +ORDER BY hr_rank LIMIT 5; +``` + diff --git a/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx new file mode 100644 index 00000000000..3deac297d90 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/detail/experiment/index.mdx @@ -0,0 +1,26 @@ +--- +title: "Experimenting with the BigAnimal free trial" +navTitle: "Experimenting" +description: "A few ideas for testing the basic capabilities of the BigAnimal system" +indexCards: none +--- + +Once you've [created a cluster](../create_a_cluster/), it's time to put it through its paces. +Here are a few examples to get you started: + +* [Import data](import_data) +* [Backup and restore](backup_and_restore) + +## Experimenting with different configurations during the trial + +You can have only one _active_ cluster at a time. But what if you want to do some extensive testing on multiple clusters? Perhaps to compare different cloud providers, regions, or database options against an [import](import_data) of a representative dataset? + +Well, if you want to configure a new cluster, you can just delete the currently active one: + +1. Navigate to the [Clusters](https://portal.biganimal.com/clusters) page on the portal. + +2. Select the delete button (trashcan icon) on the active cluster. +3. Confirm the deletion. +4. Reload the page. + +Now the **Create New Cluster** button is enabled again, and you can [create a new cluster](../create_a_cluster) or [restore a previously deleted one](backup_and_restore). diff --git a/product_docs/docs/biganimal/release/free_trial/detail/index.mdx b/product_docs/docs/biganimal/release/free_trial/detail/index.mdx new file mode 100644 index 00000000000..f2e2e820b7b --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/detail/index.mdx @@ -0,0 +1,12 @@ +--- +title: Going deeper into the BigAnimal free trial +navTitle: Going deeper +indexCards: simple +navigation: + - create_an_account + - create_a_cluster + - connect_to_a_cluster + - experiment +--- + +The [Quick start](../quickstart) presents one way to get started, but there are quite a few things to try! This section covers the various options available to you in the BigAnimal free trial and presents some ideas to get you started experimenting with the capabilities that it provides. diff --git a/product_docs/docs/biganimal/release/free_trial/index.mdx b/product_docs/docs/biganimal/release/free_trial/index.mdx new file mode 100644 index 00000000000..e00c580fa78 --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/index.mdx @@ -0,0 +1,89 @@ +--- +title: "Getting started with the BigAnimal free trial" +navTitle: "Getting started" +indexCards: none +navigation: + - quickstart + - detail +--- + +The BigAnimal free trial provides an EDB-hosted environment where you can quickly experience the features and capabilities of BigAnimal. +The free trial provides a subset of the full-featured BigAnimal environment so that you can get a feel for what to expect. + +!!! Note "Get started with BigAnimal quickly" + [Quick start for the BigAnimal free trial](quickstart) — Create, connect to, and work with + a standard community PostgreSQL 14 cluster, provisioned on AWS. + +## What you get as part of the free trial + +- **The latest & greatest PostgreSQL and EDB Postgres Advanced Server databases.** + - [PostgreSQL 14](https://www.enterprisedb.com/blog/cool-new-contributions-postgresql-14) is more flexible, more secure, and faster than ever ([release notes](https://www.postgresql.org/docs/14/release.html)). + + - [EDB Postgres Advanced Server 14](https://www.enterprisedb.com/docs/epas/latest/epas_rel_notes/) builds on PostgreSQL 14 with a host of features for Oracle database compatibility, security, and usability ([more on Oracle database compatibility](/epas/latest/epas_compat_ora_dev_guide/)). +- **One active cluster, unlimited inactive ones.** + - You can try different configurations by deleting the active cluster and creating a new one. + - Restore deleted clusters at any time within the trial period. + - Choose from either AWS or Azure cloud hosting, with two regions available for each (out of [all supported regions](/biganimal/latest/overview/03a_region_support)). + + | Cluster details | On Azure | On AWS | + | --------------- | --------------------------------------------- | ----------------------------------------------------- | + | Region | Either US East 2 or West Europe (Netherlands) | Either US-East 1 (N. Virginia) or EU-West-1 (Ireland) | + | Instance Type | Esv3 series 2 vCPU with 16 GB RAM | r5.large | + | Storage | Premium SSD disks P1 4Gi | GP3 Volume disk size 4 | + | | | | +- **Edit database configuration settings.** +- **Connect to your cluster** via a public IP from psql, pgAdmin, or your favorite PostgreSQL-friendly application. +- **Access to EDB enterprise-level support.** +- **Use BigAnimal services for 14 days.** The countdown begins when you first provision a cluster. + +(Numerous other instance types, storage types, regions, customizations, and support options are available with a paid account.) + +## Create an account + +TO get started with your free trial you'll need to [create an EDB account](detail/create_an_account). + +Registering an account on [enterprisedb.com](https://www.enterprisedb.com/) gives you access to the BigAnimal trial, as well as EDB's training and software downloads. +Accounts are free, and registration takes less than a minute. + +## Create a cluster + +The free trial allows you to create a database cluster hosted on BigAnimal to try for 14 days. While the trial allows only one cluster to be active at a time, you are free to delete your cluster and create a new one. It's even possible to restore any cluster you've previously deleted. + +BigAnimal offers both standard PostgreSQL and EDB Postgres Advanced Server clusters. You can try out either using the latest PostgreSQL version (14) or one of the previous supported versions (11–13). Other configuration options are limited for the free trial. + +There are several equivalent ways to create a cluster: + +- [Using the portal](detail/create_a_cluster/create_cluster_portal) +- [Using the CLI](detail/create_a_cluster/create_cluster_cli) + +## Connect + +Once you have a running cluster, you can connect using any PostgreSQL-compatible software. Here are a few ideas to get you going: + +- [Using psql](detail/connect_to_a_cluster/connect_using_psql) +- [Using pgAdmin](detail/connect_to_a_cluster/connect_using_pgadmin) +- [Using DBeaver](detail/connect_to_a_cluster/connect_using_dbeaver) + +## Experiment + +A database is always more interesting when it contains...data! +Load up some sample data and see what BigAnimal lets you do with it: + +- [Importing some sample data](detail/experiment/import_data) +- [Testing backups by restoring a cluster](detail/experiment/backup_and_restore) +- [Seeing EDB Postgres Advanced Server's Oracle compatibility](../using_cluster/06_demonstration_oracle_compatibility) in action + +## What you can’t do +Since this is a free trial, there are a few nuances and limitations to what you can do with a free account: + +- You can't invite team members to join your cluster or assign roles in the free trial. Other team members should create their own free trial account to explore BigAnimal. + +- The BigAnimal free trial interface notes the features that aren't available in the free trial. No private networking or superuser access is available in the trial. High availability, logging, monitoring, and performance benchmarking are also not available. + +## What happens when the free trial ends? + +Within the BigAnimal Free Trial interface, a countdown displays the time remaining for your free trial. + +When the free trial ends, your account continues to exist, but your cluster and its backup and data are deleted. You can't transfer your cluster from the free trial to a paid account. Your free trial account is separate from a paid BigAnimal account. + +We hope two weeks is enough time to give you a rough idea of what BigAnimal offers, but if you're interested in _really_ seeing it in action, we also offer an evaluation of the full product, with full access to regions and configurations. If you're interested, [contact EDB sales to learn more!](https://www.enterprisedb.com/contact) diff --git a/product_docs/docs/biganimal/release/free_trial/quickstart.mdx b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx new file mode 100644 index 00000000000..c6f5f9d557a --- /dev/null +++ b/product_docs/docs/biganimal/release/free_trial/quickstart.mdx @@ -0,0 +1,166 @@ +--- +title: "Quick start for the BigAnimal free trial" +navTitle: "Quick start" +tags: + - azure + - biganimal + - postgresql + - psql +--- + +This topic provides a quick walk-through of the steps needed to configure a PostgreSQL 14 cluster on BigAnimal running against AWS with a free trial account. + +## Step 1: Create an account and sign into the portal + +If you haven't done so already, you'll need to [create your EDB account](detail/create_an_account). + +Then, use your account to access the [BigAnimal portal](https://portal.biganimal.com/). + +## Step 2: Create an AWS cluster + +1. Select the **Clusters** link on the left to navigate to the [Clusters](https://portal.biganimal.com/clusters) page. + +2. Select the **Create New Cluster** button. + + You should now find yourself at the [Create Cluster page]<https://portal.biganimal.com/create-cluster>. + +3. Enter `AWS PostgreSQL cluster` in the **Cluster Name** field. +4. Enter a strong, memorable password in the **Password** field. + + This is the admin password for the cluster. +5. Select **PostgreSQL** for **Database Type** + + This gives you an official build of PostgreSQL. +6. Select **14** for **Postgres Version**. +4. Select **AWS** for **Provider**. +5. Select **US East 1** for **Region**. +6. For **Instance Type** and **Storage**, only one set of options is available in the trial. Select each option. +7. Select **Create Cluster**. You'll be brought back to the Clusters page with your newly configured cluster now populating the list. It usually takes a minute or two for your cluster to be ready but can take up to an hour. A progress bar is shown near the right. + +### Managing your cluster + +After you select **Create Cluster**, you'll be brought back to the Clusters page with your newly configured cluster now populating the list. In the free trial, you can provision only one cluster at a time. That said, you can delete your cluster, start a new cluster, and even restore a deleted cluster. BigAnimal automatically backs up clusters. + +Once your first cluster is fully provisioned, your 14-day free trial officially starts, and a countdown appears telling you how many days are left in your trial. + +## Step 3: Connect to your new cluster + +1. Select your cluster to get an overview of how it has been configured. Select the **Connect** tab to see more information about how to connect to your cluster. +2. Select the **Overview** tab and copy the **Quick Connect** command. Paste it into a terminal where psql is installed. It will prompt for your password and put you on a SQL command line. + + ``` + $ psql -W "postgres://edb_admin@[HOST]:5432/edb_admin?sslmode=require" + Password: + psql (13.5 (Ubuntu 13.5-2.pgdg20.04+1), server 14.2.1 (Debian 14.2.1-1+deb10)) + WARNING: psql major version 13, server major version 14. + Some psql features might not work. + SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off) + Type "help" for help. + + edb_admin=> + ``` + +!!! Note + While psql is a good all-around option for working with Postgres databases, you can use the client of your choice. See [Connect to a cluster](detail/connect_to_a_cluster) for more ideas. + + +## Things to try + +### Create a new database + +We're going to create some sample math data, so we're going to create a database called `math`. We _could_ use the default `edb_admin` database, but best practice is to isolate data. + +1. Create a new role called `math`. + + ``` + create user math with password 'math_password'; + ``` + +2. Grant the `math` role to `edb_admin`. + + ``` + grant math to edb_admin; + ``` + +3. Create a new `math` database. + + ``` + create database math with owner math; + ``` + +4. Connect to the `math` database. You're prompted for the `edb_admin` password you provided in Step 2 above. + + ``` + \connect math + ``` + + +### Populate a table and query it + +We're going to use temporary tables to calculate prime numbers using a [Sieve of Eratosthenes](https://en.wikipedia.org/wiki/Sieve_of_Eratosthenes). + +1. Create a table for storing prime numbers called `primes`. + + ```sql + CREATE TABLE primes ( + num INTEGER, + PRIMARY KEY (num) + ); + ``` + +2. Populate the table with all prime numbers up to 1000. (This code is based on [code from David Fetter](https://wiki.postgresql.org/wiki/Sieve_of_Eratosthenes).) + + ```sql + -- Based on https://wiki.postgresql.org/wiki/Sieve_of_Eratosthenes + + WITH RECURSIVE + t0(m) AS ( + VALUES(1000) + ), + t1(n) AS ( + VALUES(2) + UNION ALL + SELECT n+1 FROM t1 WHERE n < (SELECT m FROM t0) + ), + t2 (n, i) AS ( + SELECT 2*n, 2 + FROM t1 WHERE 2*n <= (SELECT m FROM t0) + UNION ALL + ( + WITH t3(k) AS ( + SELECT max(i) OVER () + 1 FROM t2 + ), + t4(k) AS ( + SELECT DISTINCT k FROM t3 + ) + SELECT k*n, k + FROM + t1 + CROSS JOIN + t4 + WHERE k*k <= (SELECT m FROM t0) + ) + ) + INSERT INTO primes ( + SELECT n FROM t1 EXCEPT + SELECT n FROM t2 + ORDER BY 1 + ); + ``` + +3. Select the largest prime number less than 1000. + + ``` + SELECT max(num) + FROM primes + WHERE num < 1000; + ``` + +## Further reading + +Now that you've got the basics out of the way, see what else BigAnimal offers: + +- [Backup and restore](detail/experiment/backup_and_restore) +- [Import data](detail/experiment/import_data) +- [CLI reference](../reference/cli) +- [API reference](../reference/api) diff --git a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx index ef2d5463dd6..b37a78c5d23 100644 --- a/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx +++ b/product_docs/docs/biganimal/release/getting_started/00_free_trial.mdx @@ -4,6 +4,8 @@ title: BigAnimal free trial EDB offers a 14-day free trial for anyone interested in exploring BigAnimal and its capabilities. The BigAnimal free trial functions like the full-featured BigAnimal so you can get a feel for what to expect. +To get the most out of the free trial quickly, see [Quick start for the BigAnimal free trial](../free_trial/quickstart.mdx). + ## How to start your free trial You can request a BigAnimal free trial from several locations: - The EDB [Get started](https://www.enterprisedb.com/get-started) sign-up page @@ -12,10 +14,21 @@ You can request a BigAnimal free trial from several locations: ## What you can do with your free trial - The free trial lasts for 14 days. The count begins when you provision a cluster. -- You can provision a single cluster with 2 vCPU and 16 GB RAM in either PostgreSQL or EDB Postgres Advanced Server with up to 4GB of Azure Premium SSD storage. -- You can choose to provision your cluster in either of 2 Azure Regions: US East 2 or West Europe (Netherlands). - - If you delete your cluster within the 14 day trial period, you can restore that cluster or you can provision a new cluster. - - Numerous other instance types, storage types, and regions are available with a paid account. +- You can provision a single cluster using either PostgreSQL or EDB Postgres Advanced Server: + + | Cluster Details | On Azure | On AWS | + | --------------- | --------------------------------------------- | ----------------------------------------------------- | + | Region | Either US East 2 or West Europe (Netherlands) | Either US-East 1 (N. Virginia) or EU-West-1 (Ireland) | + | Instance Type | Esv3 series 2 vCPU with 16 GB RAM | r5.large | + | Storage | Premium SSD disks P1 4Gi | AWS GP3 Volume, disk size 4 | + | | | | + + - Numerous other instance types, storage types, and regions are available with a paid account. + + - If you delete your cluster within the 14 day trial period, you can restore that cluster or create a new one. + + - You can try out a different cloud provider by creating, using, and then deleting your cluster on one provider and then provisioning a new cluster using the other provider within the same 14 day trial period. + - During the trial, you have access to EDB enterprise-level support. - You can connect to your database cluster. - You can edit the database configuration for a cluster and view the activity log for the service. @@ -25,7 +38,7 @@ You can request a BigAnimal free trial from several locations: Since this is a free trial, there are a few nuances and limitations to what you can do with a free account: - You cannot invite team members to join your cluster or assign roles in the free trial. Other team members should create their own free trial account to explore BigAnimal. -- Backups are only retained for 30 days. + - The BigAnimal Free Trial interface notes which features are not available in the free trial. No private networking or superuser access is available in the trial. High availability, logging, monitoring, and performance benchmarking are also not available. ## What happens when the free trial ends diff --git a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx index ee0f9612078..52aebab0672 100644 --- a/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx +++ b/product_docs/docs/biganimal/release/getting_started/creating_a_cluster/index.mdx @@ -15,17 +15,12 @@ Prior to creating your cluster, make sure you have adequate Azure resources or y 1. Sign in to the [BigAnimal](https://portal.biganimal.com) portal. 2. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. - 3. On the **Create Cluster** page, specify the cluster settings on the following tabs: - - [**Cluster Info**](#cluster-info-tab) - [**Operational Settings**](#operational-settings-tab) - - [**DB Configuration** ](#db-configuration-tab) (optional) - - [ **Availability** ](#availability-tab) (optional) - 4. Select **Create Cluster**. It might take a few minutes to deploy. !!! Note @@ -36,7 +31,6 @@ Prior to creating your cluster, make sure you have adequate Azure resources or y 1. Enter the name for your cluster in the **Cluster Name** field. 2. Enter a password for your cluster in the **Password** field. This is the password for the user edb_admin. - 3. Select **Next: Operational Settings**. ### Operational Settings tab @@ -48,30 +42,25 @@ Prior to creating your cluster, make sure you have adequate Azure resources or y - [*PostgreSQL*](/supported-open-source/postgresql/) is an open-source object-relational database management system. - [*EDB Postgres Advanced Server*](/epas/latest/) is EDB’s secure, Oracle-compatible PostgreSQL. View [a quick demonstration of Oracle compatibility on BigAnimal](../../using_cluster/06_demonstration_oracle_compatibility). - 2. In the **Version** field, select the version of Postgres that you want to use. See [Database Version Policy](../../overview/05_database_version_policy) for more information. 2. In the **Provider** field, select the cloud provider for your cluster. - -3. In the **Region** field, select the region where you want to deploy your cluster. For the best performance, EDB typically recommends that this region be the same as other resources you have that communicate with your cluster. - - For a list of available regions, see [Supported regions](../../overview/03a_region_support). - +3. In the **Region** field, select the region where you want to deploy your cluster. For the best performance, EDB typically recommends that this region be the same as other resources you have that communicate with your cluster. For a list of available regions, see [Supported regions](../../overview/03a_region_support). 4. In the **Instance Type** section, 1. Select the category that works best for your applications and workload: - memory optimized for large data sets + - compute optimized for compute bound applications - general purpose if you don't require memory or compute optimization + 1. Select the instance series and size. See [Sizes for virtual machines in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes) for information to help you choose the appropriate instance type. 5. In the **Storage** section, select **Volume Type**. In **Volume Properties**, select the type and amount of storage needed for your cluster. !!! Note BigAnimal currently supports Azure Premium SSD storage types. See [the Azure documentation](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssds) for more information. -6. In the **Networking** section, you specify whether to use private or public networking. Networking is set to Public by default. Public means that any client can connect to your cluster’s public IP address over the internet. Optionally, you can limit traffic to your public cluster by specifying an IP allowlist, which only allows access to certain blocks of IP addresses. To limit access, add one or more Classless Inter-Domain Routing (CIDR) blocks in the **IP Allowlists** section. CIDR is a method for allocating IP addresses and IP routing to a whole network or subnet. If you have any CIDR block entries, access is limited to those IP addresses. If none are specified, all network traffic is allowed. +6. In the **Networking** section, you specify whether to use private or public networking. Networking is set to Public by default. Public means that any client can connect to your cluster’s public IP address over the internet. Optionally, you can limit traffic to your public cluster by specifying an IP allowlist, which only allows access to certain blocks of IP addresses. To limit access, add one or more Classless Inter-Domain Routing (CIDR) blocks in the **IP Allowlists** section. CIDR is a method for allocating IP addresses and IP routing to a whole network or subnet. If you have any CIDR block entries, access is limited to those IP addresses. If none are specified, all network traffic is allowed. Private networking allows only IP addresses within your private network to connect to your cluster. See [Cluster networking architecture](01_cluster_networking) for more information. - - 7. To optionally make updates to your database configuration parameters, select **Next: DB Configuration**. ### DB Configuration tab diff --git a/product_docs/docs/biganimal/release/index.mdx b/product_docs/docs/biganimal/release/index.mdx index 5efe10ded3c..36403438dd4 100644 --- a/product_docs/docs/biganimal/release/index.mdx +++ b/product_docs/docs/biganimal/release/index.mdx @@ -1,11 +1,14 @@ --- title: BigAnimal description: "BigAnimal: DBaaS for PostgresSQL " -indexCards: simple +indexCards: none hideVersion: true directoryDefaults: iconName: "logos/Biganimal" navigation: + - "#Free Trial" + - free_trial + - "#Full Version" - overview - getting_started - using_cluster @@ -15,3 +18,7 @@ navigation: - reference --- + +BigAnimal is a fully managed database-as-a-service with built-in Oracle compatibility, running in your cloud account and operated by the Postgres experts. BigAnimal makes it easy to set up, manage, and scale your databases. Provision [PostgreSQL](https://www.enterprisedb.com/docs/supported-open-source/postgresql/) or [EDB Postgres Advanced Server](https://www.enterprisedb.com/docs/epas/latest/) with Oracle compatibility. + +To sample BigAnimal, [get started with a free trial](/biganimal/latest/free_trial/). \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/overview/03a_region_support.mdx b/product_docs/docs/biganimal/release/overview/03a_region_support.mdx index b2a475d6e53..79f3d111a5f 100644 --- a/product_docs/docs/biganimal/release/overview/03a_region_support.mdx +++ b/product_docs/docs/biganimal/release/overview/03a_region_support.mdx @@ -1,7 +1,10 @@ --- title: "Supported regions" --- - When using Azure, you can create a cluster in the following regions: + +## Supported Azure regions + +When using Azure, you can create a cluster in the following regions: - North America (NA): - (Canada) Canada Central @@ -22,3 +25,12 @@ title: "Supported regions" - (Asia Pacific) Australia East - (Asia Pacific) Japan East - (Asia Pacific) South East Asia (Singapore) + +## Supported AWS regions for Free Trial + +When using the AWS Free Trial, you can create a cluster in the following regions: + +- North America (NA): + - US-East-1 (N. Virginia) +- Europe, Middle East, Africa (EMEA) + - EU-West-1 (Ireland) \ No newline at end of file diff --git a/product_docs/docs/edb_plus/36/01_release_notes.mdx b/product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3600_rel_notes.mdx similarity index 75% rename from product_docs/docs/edb_plus/36/01_release_notes.mdx rename to product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3600_rel_notes.mdx index c922822d035..710c915828d 100644 --- a/product_docs/docs/edb_plus/36/01_release_notes.mdx +++ b/product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3600_rel_notes.mdx @@ -1,12 +1,12 @@ --- -title: "Release Notes" +title: "Version 36.0.0" --- <div id="release_notes" class="registered_link"></div> -New features, enhancements, bug fixes, and other changes in EDB*Plus 36 include: +New features, enhancements, bug fixes, and other changes in EDB*Plus 36.0.0 include: -| Type | Description | -| ----------- | ----------------------------------------------------------------------------------------------------------------------- | -| Enhancement | Support for EDB Postgres Advanced Server 10.0.0 | -| Enhancement | EDB Postgres Advanced Server support of Internet Protocol version 6 (IPv6) to log into EDB\*Plus. | +| Type | Description | +| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| Enhancement | Support for EDB Postgres Advanced Server 10.0.0 | +| Enhancement | EDB Postgres Advanced Server support of Internet Protocol version 6 (IPv6) to log into EDB\*Plus. | | Enhancement | EDB Postgres Advanced Server support of a Secure Sockets Layer (SSL) connection from EDB\*Plus to the EDB Postgres Advanced Server database. | \ No newline at end of file diff --git a/product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3602_rel_notes.mdx b/product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3602_rel_notes.mdx new file mode 100644 index 00000000000..54bb2dd8aac --- /dev/null +++ b/product_docs/docs/edb_plus/36/edbplus_rel_notes/edbplus3602_rel_notes.mdx @@ -0,0 +1,12 @@ +--- +title: "Version 36.0.2" +--- +<div id="release_notes" class="registered_link"></div> + +New features, enhancements, bug fixes, and other changes in EDB*Plus 36.0.2 include: + +| Type | Description | +| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Enhancement | The display format for a decimal point is now compatible with Oracle SQL*Plus [Support Ticket #75092]. | +| Security Fix | The EDB JDBC driver in EDB*Plus is upgraded to version 42.3.2.1. This upgrade fixes the CVE-2022-21724 vulnerability reported in older versions of the EDB JDBC driver. | +| Bug Fix | Describe command no linger fails for a schema qualified SYNONYM name [Support Ticket #72994]. | \ No newline at end of file diff --git a/product_docs/docs/edb_plus/36/edbplus_rel_notes/index.mdx b/product_docs/docs/edb_plus/36/edbplus_rel_notes/index.mdx new file mode 100644 index 00000000000..40b7ba80e89 --- /dev/null +++ b/product_docs/docs/edb_plus/36/edbplus_rel_notes/index.mdx @@ -0,0 +1,15 @@ +--- +title: "Release Notes" +navigation: +- edbplus3602_rel_notes +- edbplus3600_rel_notes +--- + +EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. + +The EDB\*Plus documentation describes the latest version of EDB\*Plus Version 36. The release notes in this section provide information on what was new in each release. + +| Version | Release Date | +| -------------------------------------- | ------------ | +| [36.0.2](edbplus3602_rel_notes.mdx) | 2022 Apr 04 | +| [36.0.0](edbplus3600_rel_notes.mdx) | 2018 Nov 28 | \ No newline at end of file diff --git a/product_docs/docs/edb_plus/36/index.mdx b/product_docs/docs/edb_plus/36/index.mdx index 11e1c7987ad..521faa990df 100644 --- a/product_docs/docs/edb_plus/36/index.mdx +++ b/product_docs/docs/edb_plus/36/index.mdx @@ -4,6 +4,9 @@ title: "EDB*Plus" directoryDefaults: description: "EDB*Plus Documentation and release notes." +navigation: +- edbplus_rel_notes +- 03_installing_edb_plus --- EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. EDB\*Plus accepts SQL commands, SPL anonymous blocks, and EDB\*Plus commands. @@ -15,10 +18,4 @@ EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide var - Formatting output from SQL commands - Executing batch scripts - Executing OS commands -- Recording output - -<div class="toctree" maxdepth="4"> - -introduction edb_plus installing_edb_plus using_edb_plus using_edb_plus_with_ssl command_summary conclusion - -</div> +- Recording output \ No newline at end of file diff --git a/product_docs/docs/pem/8/pem_rel_notes/index.mdx b/product_docs/docs/pem/8/pem_rel_notes/index.mdx index 7aa8c30e6bc..784fc0a5603 100644 --- a/product_docs/docs/pem/8/pem_rel_notes/index.mdx +++ b/product_docs/docs/pem/8/pem_rel_notes/index.mdx @@ -6,7 +6,7 @@ The Postgres Enterprise Manager (PEM) documentation describes the latest version | Version | Release Date | Upstream Merges | Accessibility Conformance | | ------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- | -| [8.4.0](04_840_rel_notes) | 04 Apr 2022 | NA | [Conformance Report](https://www.enterprisedb.com/accessibility) | +| [8.4.0](04_840_rel_notes) | 01 Apr 2022 | NA | [Conformance Report](https://www.enterprisedb.com/accessibility) | | [8.3.0](05_830_rel_notes) | 24 Nov 2021 | pgAdmin [5.7](https://www.pgadmin.org/docs/pgadmin4/5.7/release_notes_5_7.html#bug-fixes) | [Conformance Report](https://www.enterprisedb.com/accessibility) | | [8.2.0](06_820_rel_notes) | 09 Sep 2021 | pgAdmin [5.4](https://www.pgadmin.org/docs/pgadmin4/5.4/release_notes_5_4.html#bug-fixes), [5.5](https://www.pgadmin.org/docs/pgadmin4/5.5/release_notes_5_5.html#bug-fixes), and [5.6](https://www.pgadmin.org/docs/pgadmin4/5.6/release_notes_5_6.html#bug-fixes) | [Conformance Report](https://www.enterprisedb.com/accessibility) | | [8.1.1](07_811_rel_notes) | 22 Jul 2021 | NA | NA | diff --git a/src/pages/index.js b/src/pages/index.js index c7b8802dedb..f84f4b50d88 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -144,6 +144,12 @@ const Page = () => ( <IndexCard iconName={iconNames.CLOUD_DB} headingText="Cloud"> <IndexCardLink to="/biganimal/latest">BigAnimal</IndexCardLink> + <IndexCardLink + to="/biganimal/latest/free_trial/" + className="nested-link" + > + Free Trial + </IndexCardLink> <IndexCardLink to="/biganimal/latest/using_cluster/06_demonstration_oracle_compatibility/" className="nested-link"