HCPosh

NAME HCPosh



SYNOPSIS

HCPosh is a powershell module that provides some useful functions and tools when working with data in the Health

Catalyst Analytics Platform.





SYNTAX

HCPosh [-Version] [<CommonParameters>]



HCPosh -Config [-Force] [-Json <String>] [<CommonParameters>]



HCPosh -SqlParser -Query <String> [-Log] [-SelectStar] [-Brackets] [<CommonParameters>]



HCPosh -Impact -Server <String> [-ConfigPath <String>] [-OutDir <String>] [<CommonParameters>]



HCPosh [-OutDir <String>] -Diagrams [-OutZip] [<CommonParameters>]



HCPosh [-OutDir <String>] -Graphviz [-InputDir <String>] [-OutType <String>] [<CommonParameters>]



HCPosh [-OutDir <String>] [-OutVar] -Docs [-KeepFullLineage] [-OutZip] [<CommonParameters>]



HCPosh -Data [-OutVar] [-Raw] [-NoSplit] [<CommonParameters>]



HCPosh [-OutVar] [-Installer] [<CommonParameters>]





DESCRIPTION

Some key features include:



* built-in column-level **sql parser**, developed using the Microsoft.SqlServer.TransactSql.ScriptDom library.

* integration of **Graphviz** software for ERD and Data flow diagram generation (pdf, png, and svg)

* splits SAM Designer files into smaller files for source control





PARAMETERS

-Version [<SwitchParameter>]

Returns the version number of the **HCPosh** module



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Config [<SwitchParameter>]



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Force [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Json <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SqlParser [<SwitchParameter>]

Gets tables and columns from sql queries



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Query <String>



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Log [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-SelectStar [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Brackets [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Impact [<SwitchParameter>]



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Server <String>



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ConfigPath <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-OutDir <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Data [<SwitchParameter>]

return a metadata_raw.json and metadata_new.json, then splits these objects into a folder structure of content

for easier source control management of SAMD data models.



HCPosh -Data



output the hcx objects to a variable in-memory



$Var = HCPosh -Data -OutVar



other options when using the -Data function



HCPosh -Data -Force

HCPosh -Data -NoSplit

HCPosh -Data -Raw



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-OutVar [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Raw [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-NoSplit [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Installer [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Docs [<SwitchParameter>]



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-KeepFullLineage [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Diagrams [<SwitchParameter>]



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-OutZip [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Graphviz [<SwitchParameter>]

A description of the graphviz parameter.



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-InputDir <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-OutType <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>HCPosh -Graphviz















RELATED LINKS