Get Help

Get-CatProject

Returns the open project as one object: data sources, tests, lists, queries, outputs, settings.

Synopsis

Get-CatProject

Parameters

None (common parameters only).

What it does

Writes the project CAT built when it was opened — everything the project file and its lists resolved to. The Get-Cat* cmdlets are shortcuts to single properties of this object; use it when you need several of them, or the ones that have no cmdlet (DataSourceLists, Queries, QueryLists, TestTemplates, Outputs, Threads).

Output

One Project object: DataSources, DataSourceLists, Tests, TestLists, Queries, QueryLists, TestTemplates, Outputs, Threads, ThreadsRaw, ProjectPathInfo (ResolvedPath, ResolvedDirectory, FileNameWithoutExtension, ProvidedPath), TestGeneratorResults, ProjectDataSet.

Errors

There is no CAT project open. Use Open-CatProject to open it. when nothing is open.

Examples

$p = Open-CatProject -Path 'D:\Testing\DwhTests.cat.yaml'   # Open-CatProject returns it too
$p = Get-CatProject
$p.ProjectPathInfo.ResolvedPath
$p.Tests.Count
$p.Outputs | Select-Object Format, Path
$p.Threads