Get-RivetConfig

Gets the configuration to use when running Rivet.

Syntax

Get-RivetConfig [[-Database] <String[]>] [[-Environment] <Object>] [[-Path] <String>] [<CommonParameters>]

Description

Rivet will look in the current directory for a rivet.json file.

Related Commands

Parameters

Name Type Description Required? Pipeline Input Default Value
Database String[]

The list of specific database names being operated on.

false false
Environment Object

The name of the environment whose settings to return. If not provided, uses the default settings.

false false
Path String

The path to the Rivet configuration file to load. Defaults to rivet.json in the current directory.

false false

Return Values

Rivet.Configuration.Configuration.

EXAMPLE 1

Get-RivetConfig

Looks in the current directory for a rivet.json file, loads it, and returns an object representing its configuration.

EXAMPLE 2

Get-RivetConfig -Path F:\etc\rivet

Demonstrates how to load a custom Rivet configuration file.