https://github.com/ramblingcookiemonster/pssqlite

PowerShell module to query SQLite databases
https://github.com/ramblingcookiemonster/pssqlite

database powershell powershell-modules sqlite sqlite-database

Last synced: 10 days ago
JSON representation

PowerShell module to query SQLite databases

• Host: GitHub
• URL: https://github.com/ramblingcookiemonster/pssqlite
• Owner: RamblingCookieMonster
• License: mit
• Created: 2015-03-14T16:33:14.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-03-15T17:05:44.000Z (8 months ago)
• Last Synced: 2024-10-18T16:11:54.390Z (18 days ago)
• Topics: database, powershell, powershell-modules, sqlite, sqlite-database
• Language: PowerShell
• Homepage: http://ramblingcookiemonster.github.io/SQLite-and-PowerShell/
• Size: 5.61 MB
• Stars: 308
• Watchers: 20
• Forks: 66
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build status](https://ci.appveyor.com/api/projects/status/7pm5cjeoqx09i3co/branch/master?svg=true)](https://ci.appveyor.com/project/RamblingCookieMonster/pssqlite)

PSSQLite PowerShell Module

=============

This is a PowerShell module for working with SQLite.  It uses similar syntax to the [Invoke-Sqlcmd2](https://github.com/RamblingCookieMonster/PowerShell/blob/master/Invoke-Sqlcmd2.ps1) function from Chad Miller et al.

This covers limited functionality; contributions to this function or additional functions would be welcome!

Caveats:

* Minimal testing.

* Today was my first time working with SQLite

## Functionality

Create a SQLite database and table:

  * ![Create a SQLite database and table](/Media/Create.png)

Query a SQLite database, using parameters:

  * ![Query a SQLite database](/Media/Query.png)

Create a SQLite connection, use it for subsequent queries:

  * ![Create a SQLite connection, use it](/Media/Connection.png)

Insert large quantities of data quickly with transactions ([why?](http://www.sqlite.org/faq.html#q19)):

  * ![Insert large quantities of data quickly](/Media/Transaction.png)

## Instructions

```powershell

# One time setup

    # Download the repository

    # Unblock the zip

    # Extract the PSSQLite folder to a module path (e.g. $env:USERPROFILE\Documents\WindowsPowerShell\Modules\)

    #Simple alternative, if you have PowerShell 5, or the PowerShellGet module:

        Install-Module PSSQLite

# Import the module.

    Import-Module PSSQLite    #Alternatively, Import-Module \\Path\To\PSSQLite

# Get commands in the module

    Get-Command -Module PSSQLite

# Get help for a command

    Get-Help Invoke-SQLiteQuery -Full

# Create a database and a table

    $Query = "CREATE TABLE NAMES (fullname VARCHAR(20) PRIMARY KEY, surname TEXT, givenname TEXT, BirthDate DATETIME)"

    $DataSource = "C:\Names.SQLite"

    Invoke-SqliteQuery -Query $Query -DataSource $DataSource

# View table info

    Invoke-SqliteQuery -DataSource $DataSource -Query "PRAGMA table_info(NAMES)"

# Insert some data, use parameters for the fullname and birthdate

    $query = "INSERT INTO NAMES (fullname, surname, givenname, birthdate) VALUES (@full, 'Cookie', 'Monster', @BD)"

    Invoke-SqliteQuery -DataSource $DataSource -Query $query -SqlParameters @{

        full = "Cookie Monster"

        BD   = (get-date).addyears(-3)

    }

# View the data

    Invoke-SqliteQuery -DataSource $DataSource -Query "SELECT * FROM NAMES"

#Build up some fake data to bulk insert, convert it to a datatable

    $DataTable = 1..10000 | %{

        [pscustomobject]@{

            fullname = "Name $_"

            surname = "Name"

            givenname = "$_"

            BirthDate = (Get-Date).Adddays(-$_)

        }

    } | Out-DataTable

#Insert the data within a single transaction (SQLite is faster this way)

    Invoke-SQLiteBulkCopy -DataTable $DataTable -DataSource $DataSource -Table Names -NotifyAfter 1000 -verbose

#View all the data!

    Invoke-SqliteQuery -DataSource $DataSource -Query "SELECT * FROM NAMES"

```

## Notes

This isn't a fully featured module or function.

I'm planning to write about using SQL from a systems administrator or engineer standpoint.  I personally stick to [MSSQL and Invoke-Sqlcmd2](https://ramblingcookiemonster.wordpress.com/2014/03/12/sql-for-powershell-for-sql-newbies/), but want to provide an abstracted means to perform this without the prerequisite of an accessible MSSQL instance.

Check out Jim Christopher's [SQLite PowerShell Provider](https://psqlite.codeplex.com/).  It offers more functionality and flexibility than this repository.

Credit to Chad Miller, Justin Dearing, Paul Bryson, Joel Bennett, and Dave Wyatt for the code carried over from Invoke-Sqlcmd2.