Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/potatoqualitee/SPReplicator
♻ Replicates SharePoint Lists
https://github.com/potatoqualitee/SPReplicator
csv powershell replication sharepoint sqlserver
Last synced: about 2 months ago
JSON representation
♻ Replicates SharePoint Lists
- Host: GitHub
- URL: https://github.com/potatoqualitee/SPReplicator
- Owner: potatoqualitee
- License: mit
- Created: 2018-07-06T01:02:24.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2021-09-24T10:51:43.000Z (about 3 years ago)
- Last Synced: 2024-06-24T04:56:00.365Z (3 months ago)
- Topics: csv, powershell, replication, sharepoint, sqlserver
- Language: PowerShell
- Homepage:
- Size: 17.3 MB
- Stars: 38
- Watchers: 4
- Forks: 10
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - potatoqualitee/SPReplicator - ♻ Replicates SharePoint Lists (PowerShell)
README
# SPReplicator
SPReplicator is a PowerShell module that helps replicate SharePoint list data.
This module uses the SharePoint Client Side Object Model (CSOM), the PnP.PowerShell module and all required libraries and dlls are included. Installing the SharePoint binaries is **not required** for the replication to work 👍 Thank you Microsoft for the redistributable nuget and PnP.PowerShell.
SPReplicator works with both on-prem and SharePoint Online and is currently in beta. It also works on .NET Core, so it's cross-platform, and supports Windows, macOS and Linux.
Please report any issues to [email protected].
## Installer
SPReplicator is now in the PowerShell Gallery. Run the following from an administrative prompt to install SPReplicator for all users:
```powershell
Install-Module SPReplicator
```
Or if you don't have administrative access or want to save it locally (just for yourself), run:
```powershell
Install-Module SPReplicator -Scope CurrentUser
```
If you're scheduling tasks via Task Schedule or SQL Server agent, installing the module with administrative privileges is best because it will ensure all users have access via Program Files.
## Command Reference
For more details about commands, visit the [wiki](https://github.com/potatoqualitee/SPReplicator/wiki/Command-Reference) or use Get-Help.
## Usage scenarios
This module can be used for replicating data in a number of ways.
* Between air gapped (offline) servers that do not have direct access to each other
* Directly from SharePoint site collection to SharePoint site collection
* From SQL Server to SharePoint
* From SharePoint to SQL Server
* From CSV to SharePoint
* From SharePoint to CSV
* From On-prem to SharePoint Online and back
## Usage examples
SPReplicator has a number of commands that help you manage SharePoint lists. You can view, delete, and add records easily and there's even a command that makes it easy to see internal column names and datatypes.
#### Export from SharePoint List
```powershell
Export-SPRListItem -Site https://intranet -List Employees -Path \\nas\replicationdata\Employees.csv
```
#### Establish a session to the SharePoint site
You can specify `-Site` and `-Credential` with every command. Or you can establish a connection and not worry about specifying the Site or Credentials in subsequent command executions.
There is no need to assign the output to a variable, as it creates a reusable global variable `$global:spsite`.
```powershell
# using your own account credentials
Connect-SPRSite -Site https://intranet
# specifying other credentials
Connect-SPRSite -Site https://intranet -Credential ad\otheruser
# using your own account credentials and SP Online
Connect-SPRSite -Site https://corp.sharepoint.com -Credential [email protected]
# using MFA
Connect-SPRSite -Site https://corp.sharepoint.com -AuthenticationMode WebLogin
# using app login
Connect-SPRSite -Site https://corp.sharepoint.com -AuthenticationMode AppOnly -Credential 1e36c5cc-5281-4235-a84f-c94dc2de8800
```
#### Import to SharePoint List
Now that we've established a connection via `Connect-SPRSite`, we no longer need to specify the Site.
We can import data two ways, using `Import-SPRListItem` or `Add-SPRListItem`
```powershell
# Import from CSV
Import-SPRListItem -List Employees -Path \\nas\replicationdata\Employees.csv
# Import from SQL Server
Invoke-DbaQuery -SqlInstance sql2017 -Query "Select fname, lname where id > 100" | Add-SPRListItem -List emps
# Import any PowerShell object, really. So long as it has the properly named columns.
Get-ADUser -Filter * | Select SamAccountName, whateverelse | Add-SPRListItem -List ADList
# Didn't have time to create a good SharePoint list? Use -AutoCreateList
Get-ADUser -Filter * | Add-SPRListItem -List ADList -AutoCreateList
```
#### Find out more
This was just a subset of command examples. For more command examples, visit the [wiki](https://github.com/potatoqualitee/SPReplicator/wiki/Command-Reference) or use Get-Help.
## Selected screenshots
#### Connect to a site
#### Add a generic object to a list
#### Add SQL data to a list and auto create the list if it doesn't exist
#### This is what it looks like!
#### Get details about columns to help you format your input/output
#### Results of built-in logger (New-SPRLogList and `-LogToList`)
## Power BI
A Power BI Template can be downloaded from [here](https://github.com/potatoqualitee/SPReplicator/blob/af341f5cab4099c6efccaca965921ee2a36e4c2d/SPReplicator/bin/SPReplicator.pbit).
## Pester tested
This module comes with integration tests! If you'd like to see how I test the commands, check out [Integration.Tests.ps1](https://github.com/potatoqualitee/SPReplicator/blob/master/tests/Integration.Tests.ps1)
## Learn more
To find out more about any command, including additional examples, use `Get-Help`.
```powershell
Get-Help Get-SPRColumnDetail -Detailed
```