Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@marcomirandola
marcomirandola committed Mar 19, 2024
1 parent 1c6a936 commit 89f5212
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 152 deletions.
164 changes: 13 additions & 151 deletions CmdLets/doc/Import-FilesToDatabase.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,7 @@ Pupulates the powerLoad database with folders and files from the given list of f
## SYNTAX

```
Import-FilesToDatabase [-Files] <String[]> [-AddVersions] [[-FileCategory] <String>]
[[-FileRevisionDefinition] <String>] [[-FileLifeCycleState] <String>] [[-FileLifeCycleDefinition] <String>]
[[-FileRevisionLabel] <String>] [[-FileClassification] <String>] [[-FileCreateUser] <String>]
[[-ErrorCSVPath] <String>] [[-rootDirectories] <Hashtable>] [[-FolderCategory] <String>]
[[-FolderCreateUser] <String>] [<CommonParameters>]
Import-FilesToDatabase [-Files] <String[]> [[-rootDirectories] <Hashtable>] [-AddVersions] [[-ErrorCSVPath] <String>] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -40,148 +36,13 @@ Gets All the Files in the Path C:\temp\Files and Imports them into your IDB with
```powershell
PS C:\> $files = Get-ChildItem -Path 'C:\temp\Files' -Recurse
$pathsArray = $files | ForEach-Object { $_.FullName }
Import-FilesToDatabase -Files $pathsArray -AddVersions -ErrorCSVPath 'C:\temp\Errors.csv' -FileCreateUser 'Daniel' -FileLifeCycleState 'Finish'
Import-FilesToDatabase -Files $pathsArray -AddVersions -ErrorCSVPath 'C:\temp\Errors.csv'
```

Gets All the Files in the Path C:\temp\Files and Imports them into your IDB with the given Values. If any errors occure, they will be written into the File C:\temp\Errors.csv. When there are some changes in a file, a new version will be added.

## PARAMETERS

### -AddVersions
Treats a file change/update as a new version

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ErrorCSVPath
The Path for the CSV File with all Errors in it. Example: "C:\temp\Vault\Errors.csv"
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -FileCategory
Vault file category for all imported files. Default: "Engineering"
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -FileClassification
Vault classification for all imported files. Default: "NONE"
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -FileCreateUser
Vault create user for all imported files. Default: "Migraftion"
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -FileLifeCycleDefinition
Vault lifecycle definition for all imported files. Default: "Flexible Release Process"
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -FileLifeCycleState
Vault lifecycle state for all imported files. Default: "Work in Progress"
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -FileRevisionDefinition
Vault revision definition for all imported files. Default: "Standard Alphabetic Format"
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -FileRevisionLabel
Vault revision label for all imported files. Default: A
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Files
The Files to Import. Example: $files

Expand All @@ -197,11 +58,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -FolderCategory
Vault category for all imported folders. Default: "Folder"
### -rootDirectories
Specify Rootdirectories which get replaced by $. Example: @{"C:\TEMP\sample" = "$"}
```yaml
Type: String
Type: Hashtable
Parameter Sets: (All)
Aliases:

Expand All @@ -212,26 +73,26 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -FolderCreateUser
Vault create user for all imported folders. Default: "Migration"
### -AddVersions
Treats a file change/update as a new version
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -rootDirectories
Specify Rootdirectories which get replaced by $. Example: @{"C:\TEMP\sample" = "$"}
### -ErrorCSVPath
The Path for the CSV File with all Errors in it. Example: "C:\temp\Vault\Errors.csv"
```yaml
Type: Hashtable
Type: String
Parameter Sets: (All)
Aliases:

Expand All @@ -242,6 +103,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
25 changes: 24 additions & 1 deletion CmdLets/doc/Invoke-PowerLoadSql.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Executes SQL statements on the specified database connection.
## SYNTAX

```
Invoke-PowerLoadSql [[-Statement] <String>] [[-ScriptPath] <String>] [-OutputAsTable] [<CommonParameters>]
Invoke-PowerLoadSql [[-Statement] <String>] [[-ScriptPath] <String>] [[-Timeout] <int>] [-OutputAsTable] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -31,6 +31,14 @@ Executes the SQL Statement 'SELECT * FROM Files' and prints out every match.

### Example 2
```powershell
PS C:\> Invoke-PowerLoadSql -Statement 'SELECT * FROM Files' -Timeout 90
```

Executes the SQL Statement 'SELECT * FROM Files' and prints out every match.
The timeout for this SQL statement is set to 90 seconds

### Example 3
```powershell
PS C:\> Invoke-PowerLoadSql -ScriptPath 'C:\temp\script.sql'
```

Expand Down Expand Up @@ -83,6 +91,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Timeout
Sets the SQL command timeout in seconds. If not specified, the default timeout will apply for the SQL statement
```yaml
Type: int
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down

0 comments on commit 89f5212

Please sign in to comment.