bump version

Add ACE into testing pipeline

Examples/ImportColumns/ImportColumns.ps1

@@ -0,0 +1,9 @@
+try {Import-Module $PSScriptRoot\..\..\ImportExcel.psd1} catch {throw ; return}
+
+# Create example file
+$xlFile = "$PSScriptRoot\ImportColumns.xlsx"
+Get-Process | Export-Excel -Path $xlFile
+# -ImportColumns will also arrange columns
+Import-Excel -Path $xlFile -ImportColumns @(1,3,2) -NoHeader -StartRow 1
+# Get only pm, npm, cpu, id, processname
+Import-Excel -Path $xlFile -ImportColumns @(6,7,12,25,46) | Format-Table -AutoSize

ImportExcel.psd1

@@ -6,7 +6,7 @@
     RootModule         = 'ImportExcel.psm1'
 
     # Version number of this module.
-    ModuleVersion      = '7.3.1'
+    ModuleVersion      = '7.4.0'
 
     # ID used to uniquely identify this module
     GUID               = '60dd4136-feff-401a-ba27-a84458c57ede'

Public/Import-Excel.ps1

@@ -35,7 +35,8 @@
         [string[]]$AsText,
         [string[]]$AsDate,
         [ValidateNotNullOrEmpty()]
-        [String]$Password
+        [String]$Password,
+        [Int[]]$ImportColumns
     )
     end {
         $sw = [System.Diagnostics.Stopwatch]::StartNew()
@@ -62,6 +63,16 @@
             )
 
             try {
+                if ($ImportColumns) {
+                    $end = $Worksheet.Dimension.End.Column
+                    # Check $ImportColumns
+                    if ($ImportColumns[0] -le 0) { throw "The first entry in ImportColumns must be equal or greater 1" ; return }
+                    # Check $StartColumn and $EndColumn
+                    if (($StartColumn -ne 1) -or ($EndColumn -ne $end)) { Write-Warning -Message "If ImportColumns is set, then individual StartColumn and EndColumn will be ignored." }
+                    # Replace $Columns with $ImportColumns
+                    $Columns = $ImportColumns
+                }
+
                 if ($HeaderName) {
                     $i = 0
                     foreach ($H in $HeaderName) {
@@ -84,7 +95,7 @@
 
                     foreach ($C in $Columns) {
                         #allow "False" or "0" to be column headings
-                        $Worksheet.Cells[$StartRow, $C] | Where-Object {-not [string]::IsNullOrEmpty($_.Value) } | Select-Object @{N = 'Column'; E = { $C } }, Value
+                        $Worksheet.Cells[$StartRow, $C] | Where-Object { -not [string]::IsNullOrEmpty($_.Value) } | Select-Object @{N = 'Column'; E = { $C } }, Value
                     }
                 }
             }
@@ -185,7 +196,7 @@
                         }
                         $TextColRegEx = New-Object -TypeName regex -ArgumentList $TextColExpression , 9
                     }
-                    else {$TextColRegEx = $null}
+                    else { $TextColRegEx = $null }
                     foreach ($R in $rows) {
                         #Disabled write-verbose for speed
                         #  Write-Verbose "Import row '$R'"
@@ -194,12 +205,12 @@
                             foreach ($P in $PropertyNames) {
                                 $MatchTest = $TextColRegEx.Match($P.value)
                                 if ($MatchTest.groups.name -eq "astext") {
-                                        $NewRow[$P.Value] = $Worksheet.Cells[$R, $P.Column].Text
+                                    $NewRow[$P.Value] = $Worksheet.Cells[$R, $P.Column].Text
                                 }
                                 elseif ($MatchTest.groups.name -eq "asdate" -and $Worksheet.Cells[$R, $P.Column].Value -is [System.ValueType]) {
-                                        $NewRow[$P.Value] = [datetime]::FromOADate(($Worksheet.Cells[$R, $P.Column].Value))
+                                    $NewRow[$P.Value] = [datetime]::FromOADate(($Worksheet.Cells[$R, $P.Column].Value))
                                 }
-                                else {  $NewRow[$P.Value] = $Worksheet.Cells[$R, $P.Column].Value }
+                                else { $NewRow[$P.Value] = $Worksheet.Cells[$R, $P.Column].Value }
                             }
                         }
                         else {

__tests__/ImportExcelHeaderName.tests.ps1

@@ -1,33 +1,66 @@
+#Requires -Modules Pester
+
+if (-not (Get-command Import-Excel -ErrorAction SilentlyContinue)) {
+    Import-Module $PSScriptRoot\..\ImportExcel.psd1
+}
 
 Describe "Import-Excel on a sheet with no headings" {
     BeforeAll {
 
-        $xlfile = "TestDrive:\testImportExcel.xlsx"
-        $xlfileHeaderOnly = "TestDrive:\testImportExcelHeaderOnly.xlsx"
-        $xl = "" | Export-excel $xlfile -PassThru
+        $xlfile = "$PSScriptRoot\testImportExcel.xlsx"
+        $xlfileHeaderOnly = "$PSScriptRoot\testImportExcelHeaderOnly.xlsx"
+        $xlfileImportColumns = "$PSScriptRoot\testImportExcelImportColumns.xlsx"
 
-        Set-ExcelRange -Worksheet $xl.Sheet1 -Range A1 -Value 'A'
-        Set-ExcelRange -Worksheet $xl.Sheet1 -Range B1 -Value 'B'
-        Set-ExcelRange -Worksheet $xl.Sheet1 -Range C1 -Value 'C'
+        # Create $xlfile if it does not exist
+        if (!(Test-Path -Path $xlfile)) {
+            $xl = "" | Export-excel $xlfile -PassThru
 
-        Set-ExcelRange -Worksheet $xl.Sheet1 -Range A2 -Value 'D'
-        Set-ExcelRange -Worksheet $xl.Sheet1 -Range B2 -Value 'E'
-        Set-ExcelRange -Worksheet $xl.Sheet1 -Range C2 -Value 'F'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range A1 -Value 'A'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range B1 -Value 'B'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range C1 -Value 'C'
+    
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range A2 -Value 'D'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range B2 -Value 'E'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range C2 -Value 'F'
+    
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range A3 -Value 'G'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range B3 -Value 'H'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range C3 -Value 'I'
+    
+            Close-ExcelPackage $xl
+        }
 
-        Set-ExcelRange -Worksheet $xl.Sheet1 -Range A3 -Value 'G'
-        Set-ExcelRange -Worksheet $xl.Sheet1 -Range B3 -Value 'H'
-        Set-ExcelRange -Worksheet $xl.Sheet1 -Range C3 -Value 'I'
+        # Create $xlfileHeaderOnly if it does not exist
+        if (!(Test-Path -Path $xlfileHeaderOnly)) {
+            $xl = "" | Export-excel $xlfileHeaderOnly -PassThru
 
-        Close-ExcelPackage $xl
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range A1 -Value 'A'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range B1 -Value 'B'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range C1 -Value 'C'
 
-        # crate $xlfileHeaderOnly
-        $xl = "" | Export-excel $xlfileHeaderOnly -PassThru
+            Close-ExcelPackage $xl
+        }
 
-        Set-ExcelRange -Worksheet $xl.Sheet1 -Range A1 -Value 'A'
-        Set-ExcelRange -Worksheet $xl.Sheet1 -Range B1 -Value 'B'
-        Set-ExcelRange -Worksheet $xl.Sheet1 -Range C1 -Value 'C'
+        # Create $xlfileImportColumns if it does not exist
+        if (!(Test-Path -Path $xlfileImportColumns)) {
+            $xl = "" | Export-Excel $xlfileImportColumns -PassThru
 
-        Close-ExcelPackage $xl
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range A1 -Value 'A'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range B1 -Value 'B'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range C1 -Value 'C'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range D1 -Value 'D'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range E1 -Value 'E'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range F1 -Value 'F'
+    
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range A2 -Value '1'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range B2 -Value '2'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range C2 -Value '3'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range D2 -Value '4'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range E2 -Value '5'
+            Set-ExcelRange -Worksheet $xl.Sheet1 -Range F2 -Value '6'
+    
+            Close-ExcelPackage $xl
+        }
     }
 
     It "Import-Excel should have this shape" {
@@ -167,7 +200,7 @@ Describe "Import-Excel on a sheet with no headings" {
     }
 
     It "Should" {
-        $xlfile = "TestDrive:\testImportExcelSparse.xlsx"
+        $xlfile = "$PSScriptRoot\testImportExcelSparse.xlsx"
         $xl = "" | Export-excel $xlfile -PassThru
 
         Set-ExcelRange -Worksheet $xl.Sheet1 -Range A1 -Value 'Chuck'
@@ -224,4 +257,139 @@ Describe "Import-Excel on a sheet with no headings" {
         $actual[0].P2 | Should -Be 'B'
         $actual[0].P3 | Should -Be 'C'
     }
+
+    It "Should import correct data if -ImportColumns is used with the first column" {
+        $actual = @(Import-Excel $xlfileImportColumns -ImportColumns @(1,2,4,5))
+        $actualNames = $actual[0].psobject.properties.Name
+
+        $actualNames.Count | Should -Be 4
+        $actualNames[0] | Should -Be 'A'
+        $actualNames[2] | Should -Be 'D'
+
+        $actual.Count | Should -Be 1
+        $actual[0].A | Should -Be 1
+        $actual[0].B | Should -Be 2
+        $actual[0].D | Should -Be 4
+        $actual[0].E | Should -Be 5
+    }
+
+    It "Should import correct data if -ImportColumns is used with the first column" {
+        $actual = @(Import-Excel $xlfileImportColumns -ImportColumns @(1,3,4,5))
+        $actualNames = $actual[0].psobject.properties.Name
+
+        $actualNames.Count | Should -Be 4
+        $actualNames[0] | Should -Be 'A'
+        $actualNames[2] | Should -Be 'D'
+
+        $actual.Count | Should -Be 1
+        $actual[0].A | Should -Be 1
+        $actual[0].C | Should -Be 3
+        $actual[0].D | Should -Be 4
+        $actual[0].E | Should -Be 5
+    }
+
+    It "Should import correct data if -ImportColumns is used without the first column" {
+        $actual = @(Import-Excel $xlfileImportColumns -ImportColumns @(2,3,6))
+        $actualNames = $actual[0].psobject.properties.Name
+
+        $actualNames.Count | Should -Be 3
+        $actualNames[0] | Should -Be 'B'
+        $actualNames[2] | Should -Be 'F'
+
+        $actual.Count | Should -Be 1
+        $actual[0].B | Should -Be 2
+        $actual[0].C | Should -Be 3
+        $actual[0].F | Should -Be 6
+    }
+
+    It "Should import correct data if -ImportColumns is used without the first column" {
+        $actual = @(Import-Excel $xlfileImportColumns -ImportColumns @(2,5,6))
+        $actualNames = $actual[0].psobject.properties.Name
+
+        $actualNames.Count | Should -Be 3
+        $actualNames[0] | Should -Be 'B'
+        $actualNames[2] | Should -Be 'F'
+
+        $actual.Count | Should -Be 1
+        $actual[0].B | Should -Be 2
+        $actual[0].E | Should -Be 5
+        $actual[0].F | Should -Be 6
+    }
+
+    It "Should import correct data if -ImportColumns is used with only 1 column" {
+        $actual = @(Import-Excel $xlfile -ImportColumns @(2))
+        $actualNames = $actual[0].psobject.properties.Name
+
+        $actualNames.Count | Should -Be 1
+        $actualNames[0] | Should -Be 'B'
+
+        $actual.Count | Should -Be 2
+        $actual[0].B | Should -Be 'E'
+    }
+    
+    It "Should import correct data if -ImportColumns is used with only 1 column which is also the last" {
+        $actual = @(Import-Excel $xlfile -ImportColumns @(3))
+        $actualNames = $actual[0].psobject.properties.Name
+
+        $actualNames.Count | Should -Be 1
+        $actualNames[0] | Should -Be 'C'
+
+        $actual.Count | Should -Be 2
+        $actual[1].C | Should -Be 'I'
+    }
+
+    It "Should import correct data if -ImportColumns contains all columns" {
+        $actual = @(Import-Excel $xlfileImportColumns -ImportColumns @(1,2,3,4,5,6))
+        $actualNames = $actual[0].psobject.properties.Name
+
+        $actualNames.Count | Should -Be 6
+        $actualNames[0] | Should -Be 'A'
+        $actualNames[2] | Should -Be 'C'
+
+        $actual.Count | Should -Be 1
+        $actual[0].A | Should -Be 1
+        $actual[0].B | Should -Be 2
+        $actual[0].C | Should -Be 3
+        $actual[0].D | Should -Be 4
+        $actual[0].E | Should -Be 5
+        $actual[0].F | Should -Be 6
+    }
+
+    It "Should ignore -StartColumn and -EndColumn if -ImportColumns is set aswell" {
+        $actual = @(Import-Excel $xlfileImportColumns -ImportColumns @(5) -StartColumn 2 -EndColumn 7)
+        $actualNames = $actual[0].psobject.properties.Name
+
+        $actualNames.Count | Should -Be 1
+        $actualNames[0] | Should -Be 'E'
+
+        $actual[0].E | Should -Be '5'
+    }
+
+    It "Should arrange the columns if -ImportColumns is not in order" {
+        $actual = @(Import-Excel $xlfileImportColumns -ImportColumns @(5,1,4))
+        $actualNames = $actual[0].psobject.properties.Name
+
+        $actualNames.Count | Should -Be 3
+        $actualNames[0] | Should -Be 'E'
+        $actualNames[1] | Should -Be 'A'
+        $actualNames[2] | Should -Be 'D'
+
+        $actual[0].E | Should -Be '5'
+        $actual[0].A | Should -Be '1'
+        $actual[0].D | Should -Be '4'
+    }
+
+    It "Should arrange the columns if -ImportColumns is not in order and -NoHeader is used" {
+        $actual = @(Import-Excel $xlfileImportColumns -ImportColumns @(5,1,4) -NoHeader -StartRow 2)
+        $actualNames = $actual[0].psobject.properties.Name
+
+        $actualNames.Count | Should -Be 3
+        $actualNames[0] | Should -Be 'P1'
+        $actualNames[1] | Should -Be 'P2'
+        $actualNames[2] | Should -Be 'P3'
+
+        $actual[0].P1 | Should -Be '5'
+        $actual[0].P2 | Should -Be '1'
+        $actual[0].P3 | Should -Be '4'
+    }
 }

azure-pipelines.yml

@@ -20,6 +20,25 @@ jobs:
       vmImage: 'windows-latest'
 
     steps:
+
+    # BEGIN - ACE support for Invoke-ExcelQuery testing
+    - task: Cache@2
+      inputs:
+        key: v2 | "$(Agent.OS)" | ace
+        path: ace
+        cacheHitVar: CACHE_RESTORED
+      displayName: Cache ACE
+
+    - bash: |
+        mkdir ./ace
+        curl -o ./ace/ace.exe https://download.microsoft.com/download/3/5/C/35C84C36-661A-44E6-9324-8786B8DBE231/accessdatabaseengine_X64.exe
+      displayName: 'Download ACE'
+      condition: ne(variables.CACHE_RESTORED, 'true')
+
+    - powershell: Start-Process ./ace/ace.exe -Wait -ArgumentList "/quiet /passive /norestart"
+      displayName: 'Install ACE for Invoke-ExcelQuery testing'
+    # END - ACE support for Invoke-ExcelQuery testing
+
     - powershell: 'Install-Module -Name Pester -Force -SkipPublisherCheck'
       displayName: 'Update Pester'
     - powershell: './CI/CI.ps1 -Test'
@@ -49,6 +68,25 @@ jobs:
       vmImage: 'windows-latest'
 
     steps:
+
+    # BEGIN - ACE support for Invoke-ExcelQuery testing
+    - task: Cache@2
+      inputs:
+        key: v2 | "$(Agent.OS)" | ace
+        path: ace
+        cacheHitVar: CACHE_RESTORED
+      displayName: Cache ACE
+
+    - bash: |
+        mkdir ./ace
+        curl -o ./ace/ace.exe https://download.microsoft.com/download/3/5/C/35C84C36-661A-44E6-9324-8786B8DBE231/accessdatabaseengine_X64.exe
+      displayName: 'Download ACE'
+      condition: ne(variables.CACHE_RESTORED, 'true')
+
+    - powershell: Start-Process ./ace/ace.exe -Wait -ArgumentList "/quiet /passive /norestart"
+      displayName: 'Install ACE for Invoke-ExcelQuery testing'
+    # END - ACE support for Invoke-ExcelQuery testing
+
     - pwsh: 'Install-Module -Name Pester -Force'
       displayName: 'Update Pester'
     - pwsh: './CI/CI.ps1 -Test'

changelog.md

@@ -1,3 +1,12 @@
+# v7.4.0
+
+- Thank you to [Max Goczall](https://github.com/muschebubusche) for this contribution!
+    - `ImportColumns` parameter added to `ImportExcel`. It is used to define which columns of the ExcelPackage should be imported.
+
+```powershell
+Import-Excel -Path $xlFile -ImportColumns @(6,7,12,25,46)
+```
+
 # v7.3.1
 
 - Added query Excel spreadsheets, with SQL queries!