identify
identify column1 ... columnN
Identifies matching known patterns (Credit Card Numbers, Social Security Numbers, Crypto Addresses, Email Addresses, Phone Numbers). Can optionally provide columns to only check provided columns rather than scanning the entire row.
arguments:​
columnN
​
One or more columns that will checked for matching patterns. (type: string
)
examples:​
Query​
seed '[{"key": "Hi I am me@example.com"}]'
|| identify key
Results prior to identify stage:​
key |
---|
Hi I am me@example.com |
Results after identify stage:​
key | key_email_match_0 |
---|---|
Hi I am me@example.com | me@example.com |
flags:​
--appendStage
​
Used to append the results from a previous stage to the current stage. (provide a label, stage index, or boolean true to append the previous results)
--cache
​
A boolean value of true/false that determines whether or not to use the cache. Generally most commands will default to true.
--checkpoint
​
Format: "{CHECKPOINT NAME}:{COLUMN}" Used to store the value of the provided column (in the first row of results) in the provided name for use as a checkpoint in scheduled queries or other stages. Not encrypted. Can be accessed using $CHECKPOINTS.{CHECKPOINT NAME}$
--creditcard
​
Matches a credit card number
--crypto
​
Matches all known cryptocurrency address patterns
--crypto.btc
​
Matches a BTC wallet address
--crypto.dash
​
Matches a DASG wallet address
--crypto.eth
​
Matches a ETH wallet address
--crypto.xmr
​
Matches a XMR wallet address
--email
​
Matches an email address
--filter
​
A filter to run on the command results before completing the command. If not provided, no filter is run on the results.
--guid
​
Adds a populated random guid column.
--ip
​
Matches an IPv4 address
--labelStage
​
Used to label a stage with a user provided label.
--phone
​
Matches a phone number
--randomizeHash
​
Randomizes the stage hash, even if args and flags are the same.
--ssn
​
Matches a Social Security Number
--stats
​
Controls if a stats calculation is run on a stage after it completes.
--table
​
A comma separated list of columns to include in the command results. If not provided, all columns will be included.
--type
​
Each command has a default type, either "mapping" or "reducing". Some commands can operate as either, when "reducing" they will operate on all rows at once, when "mapping", they will operate on one row at a time.
--variable
​
Format: "{VARIABLE NAME}:{COLUMN}" Used to store the value of the provided column (in the first row of results) in the provided name for use as a variable in other stages. Can be accessed using $VARIABLES.{VARIABLE NAME}$. Stored as an encrypted secret. Not stored across queries.
support​
AMI_ENTERPRISE
AMI_FREE
AMI_PRO
BINARY_ENTERPRISE
BINARY_FREE
BINARY_PRO
DESKTOP_ENTERPRISE
DESKTOP_FREE
DESKTOP_PRO
DOCKER_ENTERPRISE
DOCKER_FREE
DOCKER_PRO