sspatch

Modify a table/database/spreadsheet to integrate the changes described in a pre-computed difference.

Usage

• sspatch [options] DATAFILE PATCHFILE
• sspatch [options] --cmd PATCHSTRING DATAFILE

Index

• Option summary
• Option details
• Examples
• Patch formats
• Database/spreadsheet file formats
• Version

Option summary

• --act=ACT
• --cmd=CMD
• --default-table=TABLE
• --help
• --inplace
• --input-formats
• --neither
• --ours
• --output=OUTPUTFILE
• --patch-formats
• --table=TABLE
• --theirs

Option details

--act=ACT
filter for an action of a particular type (update, insert, delete, none, schema)

--cmd=CMD
specify an action inline in tdiff format

--default-table=TABLE
name to use when a table name is needed and not supplied

--help
show how to use this program

--inplace
if modifications are made, make them in place without a copy

--input-formats
list supported input database formats

--neither
in case of conflict use cell value from common ancestor

--ours
in case of conflict use cell value that was the local choice

--output=OUTPUTFILE
direct output to this file (default is standard output)

--patch-formats
list supported patch formats

--table=TABLE
filter for a named table of a workbook/database (repeat option for multiple tables)

--theirs
in case of conflict use cell value that wasn't the local choice

Examples

You can generate test file(s) for the examples that follow:

sspatch --test-file directory.sqlite
sspatch --test-file numbers.csv
sspatch --test-file numbers_buggy.csv
sspatch --test-file numbers_buggy.sqlite

Example 1

sspatch numbers_buggy.csv numbers_patch.tdiff

Apply a patch to a table. Output goes to standard output. Input file is untouched.

Example 2

sspatch --inplace numbers_buggy.csv numbers_patch.tdiff

Apply a patch to a table. Input file is modified.

Example 3

sspatch --tmp tmp.sqlite numbers_buggy.sqlite numbers_patch.tdiff

Apply a patch to a sqlite database. Input file is not modified. Space for a temporary database is needed to do this. If not supplied, sspatch will ask for it.

Example 4

sspatch - numbers_patch.tdiff < numbers_buggy.csv

Apply a patch to a table read from standard input.

Example 5

sspatch numbers_buggy.csv - < numbers_patch.tdiff

Apply a patch read from standard input.

Example 6

sspatch --cmd "+ |two|2|" numbers_buggy.csv

Add a new row to a table.

Example 7

sspatch --cmd "- |NAME=four|" numbers.csv

Remove a row from a table

Example 8

sspatch --cmd "= |NAME=four|DIGIT:*->4|" numbers_buggy.csv

Change the DIGIT column on a row with NAME=four.

Example 9

sspatch --inplace  --table organizations \
--cmd "+ |42|The New Organization|" directory.sqlite

Add an organization. The specified organization ID is replaced by an autoincremented ID generated by sqlite. Use 'ssformat directory.sqlite' to view result.

Example 10

sspatch --native --inplace  --table organizations \
--cmd "+ |42|The New Organization|" directory.sqlite

Add an organization. The specified organization ID is used (due to --native flag). Use 'ssformat directory.sqlite' to view result.

Patch formats

• tdiff: [default] reminiscent of the standard unix diff format for text
• csv: csv-compatible diff format
• hilite: colorful spreadsheet format
• index: tabular output showing relationship between rows and columns
• novel: mark all shared rows - remaining rows are unmatched
• ops: summarize modified rows in a table
• raw: verbose diff format for debugging
• review: spreadsheet diff format suitable for quickly accepting or rejecting changes
• sql: SQL format (data diffs only)
• stats: produce statistics on table changes

Database/spreadsheet file formats

CSV: plain-text delimiter-separated family of formats

• .csv: Comma-separated values
• .tsv: Tab-separated values
• .ssv: Semicolon-separated values
• .json: {
  "type": "csv", // CSV family
  "file": "fname.dsv", // File name
  "delimiter": "|" // Delimiter character
  }

SQLITE: file-based database

• .sqlite: Sqlite database file
• .json: {
  "type": "sqlite", // Sqlite family
  "file": "fname.db" // File name
  }
• dbi:sqlite:fname.db (Force sqlite interpretation)

SQLITEXT: sqlite-format sql dump

• .sqlitext: SQL dump of Sqlite database
• .json: {
  "type": "sqlitext", // Sqlitext family
  "file": "fname.sql" // File name
  }
• dbi:sqlitext:fname.sql (Force sqlitext interpretation)

JSONBOOK: Spreadsheet formats in json

• .jsonbook: Json spreadsheet
• .json: {
  "type": "jsonbook", // Json spreadsheet
  "file": "fname.sheet", // File name
  "hash": "1" // Generate hash/dict/objects for each row when schema available
  }
• dbi:jsonbook:fname.sheet (Force Json spreadsheet interpretation)

GNUMERIC: Spreadsheet formats (via gnumeric)

• .xls: Excel spreadsheet
• .xlsx: Excel spreadsheet
• .gnumeric: Gnumeric spreadsheet
• .ods: OpenOffice/LibreOffice spreadsheet
• .json: {
  "type": "gnumeric", // Gnumeric family
  "file": "fname.sheet" // File name
  }
• dbi:gnumeric:fname.sheet (Force Gnumeric interpretation)

MDB: Access database format (via Mdbtools, READ-ONLY)

• .mdb: Access database file
• .json: {
  "type": "access", // Access family
  "file": "fname.db" // File name
  }
• dbi:access:fname.db (Force Access interpretation)

JMDB: Access database format (via Jackcess)

• .mdb: Access database file
• .json: {
  "type": "access", // Jackcess/access family
  "file": "fname.db" // File name
  }
• dbi:jackess:fname.db (Force Access interpretation)

MYSQL: database connector

• .json: {
  "type": "mysql", // MYSQL connector
  "database": "db_name", // Database name
  "host": "localhost", // Host name
  "port": "1111", // Port number
  "username": "root", // Username
  "password": "****" // Password
  }
• dbi:mysql:database_name (Use default port, username, etc)
• dbi:mysql:database_name:username=USER:password=PASS
• dbi:mysql:database_name:host=HOST:port=PORT

SOCIALCALC: SocialCalc format (via mozjs)

• .socialcalc: SocialCalc spreadsheet file
• .sc: SocialCalc spreadsheet file
• .json: {
  "type": "socialcalc", // SocialCalc family
  "file": "sheet.txt" // File name
  }
• dbi:socialcalc:sheet.txt (Force SocialCalc interpretation)

Version

sspatch version 0.6.5