Skip to content

Commit

Permalink
Fixing documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
splatteredbits committed Sep 9, 2024
1 parent b9eb070 commit 326beb2
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 6 deletions.
4 changes: 3 additions & 1 deletion Yodel/Functions/MsSql/Get-YMsSqlTableColumn.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ function Get-YMsSqlTableColumn
#>
[CmdletBinding()]
param(
# The connection to Microsoft SQL Server.
# The connection to Microsoft SQL Server. Use `Connect-YDatabase` to create a connection, or pass any ADO.NET
# connection object.
[Parameter(Mandatory)]
[Data.Common.DbConnection] $Connection,

Expand All @@ -37,6 +38,7 @@ function Get-YMsSqlTableColumn
[Parameter(Mandatory)]
[String] $TableName,

# The name of the column to get. By default, all of the table's columns are returned.
[String] $Name
)

Expand Down
9 changes: 5 additions & 4 deletions Yodel/Functions/MsSql/Test-YMsSqlExtendedProperty.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ function Test-YMsSqlExtendedProperty
#>
[CmdletBinding(DefaultParameterSetName='Raw')]
param(
# The connection to Microsoft SQL Server.
# The connection to Microsoft SQL Server. Use `Connect-YDatabase` to create a connection, or pass any ADO.NET
# connection object.
[Parameter(Mandatory)]
[Data.Common.DbConnection] $Connection,

Expand All @@ -59,13 +60,13 @@ function Test-YMsSqlExtendedProperty
[Parameter(ParameterSetName='ForTableColumn')]
[String] $SchemaName,

# The table name whose extended property to set, or the table name of the column whose extended property to
# set.
# The table name whose extended property to test, or the table name of the column whose extended property to
# test.
[Parameter(Mandatory, ParameterSetName='ForTable')]
[Parameter(Mandatory, ParameterSetName='ForTableColumn')]
[String] $TableName,

# The column name whose extended property to set.
# The column name whose extended property to test.
[Parameter(Mandatory, ParameterSetName='ForTableColumn')]
[String] $ColumnName,

Expand Down
4 changes: 4 additions & 0 deletions Yodel/Functions/MsSql/Test-YMsSqlTable.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,15 @@ function Test-YMsSqlTable
Demonstrates how to test if a table exists by passing the table name to the `Name` parameter.
#> [CmdletBinding()]
param(
# The connection to Microsoft SQL Server. Use `Connect-YDatabase` to create a connection, or pass any ADO.NET
# connection object.
[Parameter(Mandatory)]
[Data.Common.DbConnection] $Connection,

# The schema name of the table whose existence to test. The default is `dbo`.
[String] $SchemaName = 'dbo',

# The name of the table whose existence to test.
[Parameter(Mandatory)]
[String] $Name,

Expand Down
6 changes: 5 additions & 1 deletion Yodel/Functions/MsSql/Test-YMsSqlTableColumn.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ function Test-YMsSqlTableColumn
.DESCRIPTION
The `Test-YMsSqlTableColumn` function tests if a column exists on a table in SQL Server. Pass the connection to SQL
Server to the `Connection` parameter, the table name to the `TabkeName` parameter, and the column name to the
Server to the `Connection` parameter, the table name to the `TableName` parameter, and the column name to the
`ColumnName` parameter. Returns `$true` if the column exists, and `$false` otherwise.
If the table is in a custom
Expand All @@ -21,14 +21,18 @@ function Test-YMsSqlTableColumn
#>
[CmdletBinding()]
param(
# The database connection. Use `Connect-YDatabase` to create a connection.
[Parameter(Mandatory)]
[Data.Common.DbConnection] $Connection,

# The table's schema name. The default is `dbo`.
[String] $SchemaName = 'dbo',

# The name of the table whose columns to test.
[Parameter(Mandatory)]
[String] $TableName,

# The name of the column whose existence to test.
[Parameter(Mandatory)]
[String] $Name,

Expand Down

0 comments on commit 326beb2

Please sign in to comment.