mockpipe 0.0.7

db_path

path

any

mockpipe.db

sample.db

path of duckdb db

delete_behaviour

string

[soft, hard]

soft

soft

whether deleted records will be marked as deleted with ‘D’ or actually hard deleted in the persisted db

inter_action_delay

float

0.0 ->

0.5

0.1

delay between each action

output

table

output format

full_load

table

N/A

periodic full-table snapshot export, alongside the incremental change stream. See ‘Full Load’

format

string

[json, csv, parquet]

json

json

file format output

path

path

any

extract

extract

folder path for output

include_deletes

bool

any

false

true

whether soft-deleted rows are included in the full snapshot

frequency

int

1 ->

100

50

how many recorded changes between each full snapshot export

name

string

any

N/A

employees

table name used. Also used for output

fields

table

List of fields in table

actions

table

List of actions within table

name

string

any

N/A

order_date

table name used. Also used for output

type

string

[string, int, float, boolean]

N/A

string

List of fields in table

value

string

[increment, static(*), table_random(), fake.*]

N/A

fake.date_between

List of actions within table

See ‘Field Value Usage’

arugments

list

any

N/A

• “-1y”

• “today”

Arguments to pass to faker functions

See ‘Field Value Usage’

name

string

any

N/A

update_order_status

name of action

field

string

any

N/A

order_status

field which gets updated

action

string

[create, delete, set]

N/A

set

type of action to perform

value

string

[increment, static(*), table_random(), fake.*]

N/A

fake.random_element

value to set field to

arguments

list

any

N/A

(‘pending’, ‘completed’, ‘shipped’, ‘delivered’)

if using faker, arguments to pass

frequency

float

0->1

N/A

0.25

relative frequency of action

where_condition

string

<table>.<value> == <condition>

N/A

products.product_id == table_random(products, product_id, 0)

where condition to limit which rows in table to apply action to

See where condition

action_condition

string

EFFECT_ONLY

N/A

EFFECT_ONLY

used to specify if the action is only ever to be invoked by another action (i.e., an effect)

effect

string

<table>.<action>(<target_col>=<source_col>, …)

N/A

product.product_count(order_id=order_id)

After the specified action is executed, another action can be invoked, passing values onwards to the next action

See Effect

effect_count

[int, string]

0->max(int), inherit

N/A

inherit

if effect is set, how many times to invoke the next effect

See Effect

effect_count_random

string

<min>,<max>

N/A

1,5

if effect is set, how many times to invoke the next effect

See Effect

explanation

Will only wok for integer fields. It acts as you’d expect, incrementing the value by 1 for each new row generated and selecting a random value from the specified table respectively.

syntax

increment

examples

increment

explanation

Will set a static value on each new row generated. This can be any value you want, but it will be the same for each row generated.

syntax

static(<value>)

examples

static(false), static(100), static('pending')

explanation

Will select a random value from the specified table for each new row generated. Note, will only select non-deleted rows. It’s important to set a default value in case the table is empty.

syntax

table_random(<table_name>, <column_name>, <default_value>)

examples

table_random(products, product_id, 0)

explanation

Will generate a value using the faker library. The arguments key can be used to pass arguments to the faker function.

syntax

fake.<faker_function>

examples

fake.company

explanation

Which action to invoke after the current action is executed.

syntax

<table>.<action>(<target_col>=<source_col>, <target_col=<source_col>, ...)

example

effect: product.product_count(order_id=order_id)

explanation

If the effect is set, how many times to invoke the next effect. Note, can not be used with effect_count_random.

syntax

<int>

example

1

explanation

If the effect is set, how many times to invoke the next effect. Note, can not be used with effect_count.

syntax

<min>,<max>

example

1,5

explanation

Used to specify if the action is only ever to be invoked by another action (i.e., an effect).

syntax

EFFECT_ONLY

example

EFFECT_ONLY

explanation

The where condition is used to limit which rows in the table an action is applied to. It can be set to a filter, i.e. where status==’pending’ or it can perform a lookup to another table to get the value to filter on.

syntax

<table>.<value> == / != / >= / <= / > / < <condition>

table_random condition syntax

table_random(<table_name>, <column_name>, <default_value>)

static syntax

static(<value>)

table_random example

products.product_id == table_random(orders, product_id, 0)

static example

products.product_id == static(1)