Get-VEPSQLDatabase

Short Description

Returns backed-up PostgreSQL databases.

Applies to

Veeam Backup & Replication

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Get-VEPSQLDatabase [-Session] <VEPSQLRestoreSession> [[-Name] <String[]>] [[-InstanceName] <String[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns an array of backed-up PostgreSQL databases.

After you get the backed-up PostgreSQL databases, you can use the Start-VEPSQLDatabaseExport cmdlet to export the necessary databases.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Session

Specifies an active restore session. The cmdlet will return an array of databases within the specified restore session.

Accepts the VEPSQLRestoreSession object. To get this object, run the Get-VEPSQLRestoreSession cmdlet.

True

0

True (ByValue)

Name

Specifies an array of names of PostgreSQL databases. The cmdlet will return an array of databases with the specified names.

String[]

False

1

False

InstanceName

Specifies an array of names of PostgreSQL instances. The cmdlet will return an array of databases located on the specified instances.

String[]

False

2

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

The cmdlet returns the VEPSQLDatabase[] object that contains an array of backed-up PostgreSQL databases.

Examples

Get-VEPSQLDatabaseExample 1. Getting All PostgreSQL Databases Within Specified Restore Session

This example shows how to get an array of all PostgreSQL databases within the specified restore session.

$session = Get-VEPSQLRestoreSession

$database = Get-VEPSQLDatabase -Session $session[1]

Perform the following steps:

  1. Run the Get-VEPSQLRestoreSession cmdlet. Save the result to the $session variable.

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session (in our example, it is the second restore session in the array).

  1. Run the Get-VEPSQLDatabase cmdlet. Set the $session variable as the Session parameter value and select the necessary restore session. Save the result to the $database variable to be able to use it with other cmdlets.

Get-VEPSQLDatabaseExample 2. Getting PostgreSQL Databases With Specified Names

This example shows how to get an array of PostgreSQL databases with the specified names.

$session = Get-VEPSQLRestoreSession

$dbnames = @("fiscal", "sales", "IT")

$database = Get-VEPSQLDatabase -Session $session[0] -Name $dbnames

Perform the following steps:

  1. Run the Get-VEPSQLRestoreSession cmdlet. Save the result to the $session variable.

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session. In our example, it is the first restore session in the array.

  1. Declare the $dbnames variable. Assign to this variable an array with the names of the necessary PostgreSQL databases.
  2. Run the Get-VEPSQLDatabase cmdlet. Set the $session variable as the Session parameter value and specify the necessary restore session. Set the $dbnames variable as the Name parameter value. Save the result to the $database variable to be able to use it with other cmdlets.

Get-VEPSQLDatabaseExample 3. Getting All PostgreSQL Databases on Specified Instances

This example shows how to get all PostgreSQL databases on specific instances.

$session = Get-VEPSQLRestoreSession

$instancenames = @("rhel01:5433", "rhel01:5434")

$database = Get-VEPSQLDatabase -Session $session[0] -InstanceName @instancenames

Perform the following steps:

  1. Run the Get-VEPSQLRestoreSession cmdlet. Save the result to the $session variable.

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session. In our example, it is the first restore session in the array.

  1. Declare the $instancenames variable. Assign to this variable an array with the names of the necessary PostgreSQL instances.
  2. Run the Get-VEPSQLDatabase cmdlet. Set the $session variable as the Session parameter value and specify the necessary restore session. Set the $instancenames variable as the InstanceName parameter value. Save the result to the $database variable to be able to use it with other cmdlets.

Related Commands

Get-VEPSQLRestoreSession