schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sdf-schema-1.1.json
CompressionType
Compress table data using these methods
{"oneOf": [{"type": "string", "enum": ["tar", "zstd"]}, {"type": "string", "enum": ["bzip2"]}, {"type": "string", "enum": ["gzip"]}, {"type": "string", "enum": ["none"]}]}
sdf-schema-1.1.json
CompressionType
BZIP2 Compression (.bz2)
{"type": "string", "enum": ["bzip2"]}
sdf-schema-1.1.json
CompressionType
GZIP Compression (.gzip)
{"type": "string", "enum": ["gzip"]}
sdf-schema-1.1.json
CompressionType
None, (default)
{"type": "string", "enum": ["none"]}
sdf-schema-1.1.json
Classifier
A classifier defines the labels that can be attached to columns or a table.
{"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "labels": {"type": ["array", "null"], "items": {}}, "scope": {"anyOf": [{}, {"type": "null"}]}, "cardinality": {"anyOf": [{}, {"type": "null"}]}, "propagate": {"type": ["boolean", "null"]}, "source-locations": {"anyOf": [{}, {"type": "null"}]}}, "additionalProperties": false}
sdf-schema-1.1.json
name
The name of the classifier type
{"type": "string"}
sdf-schema-1.1.json
description
A description of this classifier type
{"type": ["string", "null"]}
sdf-schema-1.1.json
labels
Named classifier labels
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
scope
scope of the classifier: table or column
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
cardinality
cardinality of the classifier: zero-or-one, one or zero-or-many
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
propagate
does the classifier propagate from scope to scope or is it a one scope marker
{"type": ["boolean", "null"]}
sdf-schema-1.1.json
source-locations
Classifier defined by these set of .sdf files
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
Label
A classifier element is a scoped classifier label (e.g. the element PII belongs to the classifier scope data)
{"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}}, "additionalProperties": false}
sdf-schema-1.1.json
name
The name of the label, use "*" to allow arbitrary strings as labels
{"type": "string"}
sdf-schema-1.1.json
description
A description of this classifier element
{"type": ["string", "null"]}
sdf-schema-1.1.json
Function
A function block defines the signature for user defined
{"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "section": {"type": ["string", "null"]}, "dialect": {"anyOf": [{}, {"type": "null"}]}, "variadic": {"anyOf": [{}, {"type": "null"}]}, "kind": {"anyOf": [{}, {"type": "null"}]}, "parameters": {"type": ["array", "null"], "items": {}}, "optional-parameters": {"type": ["array", "null"], "items": {}}, "returns": {"anyOf": [{}, {"type": "null"}]}, "binds": {"type": ["array", "null"], "items": {}}, "volatility": {"anyOf": [{}, {"type": "null"}]}, "examples": {"type": ["array", "null"], "items": {}}, "cross-link": {"type": ["string", "null"]}, "reclassify": {"type": ["array", "null"], "items": {}}, "source-locations": {"type": ["array", "null"], "items": {}}}, "additionalProperties": false}
sdf-schema-1.1.json
name
The name of the function [syntax: [[catalog.]schema].function]
{"type": "string"}
sdf-schema-1.1.json
section
The generic type bounds
{"type": ["string", "null"]}
sdf-schema-1.1.json
dialect
The dialect that provides this function
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
description
A description of this function
{"type": ["string", "null"]}
sdf-schema-1.1.json
variadic
Arbitrary number of arguments of an common type out of a list of valid types
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
kind
The function kind
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
parameters
The arguments of this function
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
optional-parameters
The arguments of this function
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
returns
The results of this function (can be a tuple)
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
binds
The generic type bounds
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
volatility
volatility - The volatility of the function.
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
examples
example - Example use of the function (tuple with input/output)
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
cross-link
cross-link - link to existing documentation, for example: https://prestodb.io/docs/current/functions/datetime.html#truncation-function
{"type": ["string", "null"]}
sdf-schema-1.1.json
reclassify
Array of reclassify instructions for changing the attached classifier labels
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
source-locations
Function defined by these set of .sdf files
{"type": ["array", "null"], "items": {}}
sdf-schema-1.1.json
Variadic
Arbitrary number of arguments of an common type out of a list of valid types
{"oneOf": [{"type": "string", "enum": ["uniform"]}, {"type": "string", "enum": ["even-odd"]}]}
sdf-schema-1.1.json
Variadic
All arguments have the same types
{"type": "string", "enum": ["uniform"]}
sdf-schema-1.1.json
Variadic
All even arguments have one type, odd arguments have another type
{"type": "string", "enum": ["even-odd"]}
sdf-schema-1.1.json
Parameter
A function parameter
{"type": "object", "properties": {"name": {"type": ["string", "null"]}, "datatype": {"type": ["string", "null"]}, "nullable": {"type": ["boolean", "null"]}, "classifier": {"type": ["array", "null"], "items": {"type": "string"}}, "constant": {"type": ["string", "null"]}, "identifiers": {"type": ["array", "null"], "items": {"type": "string"}}}, "additionalProperties": false}
sdf-schema-1.1.json
name
The name of the parameter
{"type": ["string", "null"]}
sdf-schema-1.1.json
description
A description of this parameter
{"type": ["string", "null"]}
sdf-schema-1.1.json
datatype
The datatype of this parameter
{"type": ["string", "null"]}
sdf-schema-1.1.json
nullable
The nullability of this column
{"type": ["boolean", "null"]}
sdf-schema-1.1.json
classifier
An array of classifier references
{"type": ["array", "null"], "items": {"type": "string"}}
sdf-schema-1.1.json
constant
The required constant value of this parameter
{"type": ["string", "null"]}
sdf-schema-1.1.json
identifiers
The parameter may appear as identifier, without quote
{"type": ["array", "null"], "items": {"type": "string"}}
sdf-schema-1.1.json
OptionalParameter
A function parameter
{"type": "object", "required": ["datatype", "name"], "properties": {"name": {"type": "string"}, "datatype": {"type": "string"}, "classifier": {"type": ["array", "null"], "items": {"type": "string"}}, "constant": {"type": ["string", "null"]}, "identifiers": {"type": ["array", "null"], "items": {"type": "string"}}}, "additionalProperties": false}
sdf-schema-1.1.json
name
The name of the parameter
{"type": "string"}
sdf-schema-1.1.json
description
A description of this parameter
{"type": ["string", "null"]}
sdf-schema-1.1.json
datatype
The datatype of this parameter
{"type": "string"}
sdf-schema-1.1.json
classifier
An array of classifier references
{"type": ["array", "null"], "items": {"type": "string"}}
sdf-schema-1.1.json
constant
The required constant value of this parameter
{"type": ["string", "null"]}
sdf-schema-1.1.json
identifiers
The parameter may appear as identifier, without quote
{"type": ["array", "null"], "items": {"type": "string"}}
sdf-schema-1.1.json
Volatility
A function's volatility, which defines the functions eligibility for certain optimizations
{"oneOf": [{"type": "string", "enum": ["pure"]}, {"type": "string", "enum": ["stable"]}, {"type": "string", "enum": ["volatile"]}]}
sdf-schema-1.1.json
Volatility
Pure - An pure function will always return the same output when given the same input.
{"type": "string", "enum": ["pure"]}
sdf-schema-1.1.json
Volatility
Stable - A stable function may return different values given the same input across different queries but must return the same value for a given input within a query.
{"type": "string", "enum": ["stable"]}
sdf-schema-1.1.json
Volatility
Volatile - A volatile function may change the return value from evaluation to evaluation. Multiple invocations of a volatile function may return different results when used in the same query.
{"type": "string", "enum": ["volatile"]}
sdf-schema-1.1.json
input
The sql string corresponding to the input of this example
{"type": "string"}
sdf-schema-1.1.json
output
The output corresponding to running the input string
{"type": "string"}
sdf-schema-1.1.json
Plugin
A function block defines the signature for user defined
{"type": "object", "required": ["binary", "extension", "format", "name"], "properties": {"name": {"type": "string"}, "binary": {"type": "string"}, "extension": {"type": "string"}, "format": {"type": "string"}}, "additionalProperties": false}
sdf-schema-1.1.json
name
The name of the plugin [e.g.: pyspark]
{"type": "string"}
sdf-schema-1.1.json
binary
Full path to the binary [e.g.: /usr/bin/python3]
{"type": "string"}
sdf-schema-1.1.json
extension
File extension to scan in the includes directories; must be unique [e.g.: .py]
{"type": "string"}
sdf-schema-1.1.json
format
Format of the output files; must be known to SDF [e.g.: spark-lp-json]
{"type": "string"}
role-arg-spec.json
description
Detailed explanation of what this option does. It should be written in full sentences.
{"oneOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}
role-arg-spec.json
option-name
The name of the option/argument.
{"type": "string"}
stryker-core.json
JSON schema for the Stryker Mutator configuration file
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "definitions": {"commandRunnerOptions": {"type": "object", "properties": {"command": {"type": "string", "default": "npm test"}}}, "logLevel": {"type": "string", "enum": ["off", "fatal", "error", "warn", "info", "debug", "trace"], "tsEnumNames": ["Off", "Fatal", "Error", "Warning", "Information", "Debug", "Trace"]}, "coverageAnalysis": {"type": "string", "enum": ["off", "all", "perTest"]}, "reportType": {"type": "string", "enum": ["full", "mutationScore"], "tsEnumNames": ["Full", "MutationScore"]}, "clearTextReporterOptions": {"type": "object", "properties": {"allowColor": {"type": "boolean", "default": true}, "allowEmojis": {"type": "boolean", "default": false}, "logTests": {"type": "boolean", "default": true}, "maxTestsToLog": {"type": "integer", "minimum": 0, "default": 3}}}, "dashboardOptions": {"additionalProperties": false, "type": "object", "properties": {"project": {"type": "string"}, "version": {"type": "string"}, "module": {"type": "string"}, "baseUrl": {"type": "string", "default": "https://dashboard.stryker-mutator.io/api/reports"}, "reportType": {"default": "full"}}}, "eventRecorderOptions": {"additionalProperties": false, "type": "object", "properties": {"baseDir": {"type": "string", "default": "reports/mutation/events"}}}, "htmlReporterOptions": {"additionalProperties": false, "type": "object", "properties": {"fileName": {"type": "string", "default": "reports/mutation/mutation.html"}}}, "jsonReporterOptions": {"additionalProperties": false, "type": "object", "properties": {"fileName": {"type": "string", "default": "reports/mutation/mutation.json"}}}, "mutationScoreThresholds": {"additionalProperties": false, "type": "object", "properties": {"high": {"default": 80}, "low": {"default": 60}, "break": {"oneOf": [{"type": "null"}, {}], "default": null}}}, "percentage": {"type": "number", "minimum": 0, "maximum": 100}, "mutatorDescriptor": {"type": "object", "additionalProperties": false, "properties": {"plugins": {"anyOf": [{"type": "array", "items": {"type": ["string", "array"]}}, {"type": "null"}], "default": null}, "excludedMutations": {"type": "array", "items": {"type": "string"}, "default": []}}}, "warningOptions": {"type": "object", "default": {}, "properties": {"unknownOptions": {"type": "boolean", "default": true}, "preprocessorErrors": {"type": "boolean", "default": true}, "unserializableOptions": {"type": "boolean", "default": true}, "slow": {"type": "boolean", "default": true}}}}, "properties": {"allowConsoleColors": {"type": "boolean", "default": true}, "buildCommand": {"type": "string", "examples": ["tsc -b", "babel src --out-dir lib", "npm run build"]}, "checkers": {"type": "array", "items": {"type": "string"}, "default": []}, "checkerNodeArgs": {"type": "array", "default": [], "items": {"type": "string"}}, "concurrency": {"type": "number"}, "commandRunner": {"default": {}}, "coverageAnalysis": {"default": "perTest"}, "clearTextReporter": {"default": {}}, "dashboard": {"default": {}}, "dryRunOnly": {"type": "boolean", "default": false}, "eventReporter": {"default": {}}, "ignorePatterns": {"type": "array", "items": {"type": "string"}, "default": []}, "ignoreStatic": {"type": "boolean", "default": false}, "incremental": {"type": "boolean", "default": false}, "incrementalFile": {"type": "string", "default": "reports/stryker-incremental.json"}, "force": {"type": "boolean", "default": false}, "fileLogLevel": {"default": "off"}, "inPlace": {"type": "boolean", "default": false}, "logLevel": {"default": "info"}, "maxConcurrentTestRunners": {"type": "number", "default": 9007199254740991}, "maxTestRunnerReuse": {"type": "number", "default": 0}, "mutate": {"type": "array", "items": {"type": "string"}, "default": ["{src,lib}/**/!(*.+(s|S)pec|*.+(t|T)est).+(cjs|mjs|js|ts|jsx|tsx|html|vue)", "!{src,lib}/**/__tests__/**/*.+(cjs|mjs|js|ts|jsx|tsx|html|vue)"]}, "mutator": {"default": {}}, "packageManager": {"enum": ["npm", "yarn", "pnpm"]}, "plugins": {"type": "array", "items": {"type": "string"}, "default": ["@stryker-mutator/*"]}, "appendPlugins": {"type": "array", "items": {"type": "string"}, "default": []}, "reporters": {"type": "array", "items": {"type": "string"}, "default": ["clear-text", "progress", "html"]}, "htmlReporter": {"default": {}}, "jsonReporter": {"default": {}}, "disableTypeChecks": {"oneOf": [{"type": "boolean"}, {"type": "string"}], "examples": ["{test,src,lib}/**/*.{js,ts,jsx,tsx,html,vue,cts,mts}"], "default": true}, "symlinkNodeModules": {"type": "boolean", "default": true}, "tempDirName": {"type": "string", "default": ".stryker-tmp"}, "cleanTempDir": {"enum": ["always", false, true], "default": true}, "testRunner": {"type": "string", "default": "command"}, "testRunnerNodeArgs": {"type": "array", "default": [], "items": {"type": "string"}}, "thresholds": {"default": {}}, "timeoutFactor": {"type": "number", "default": 1.5}, "timeoutMS": {"type": "number", "default": 5000}, "dryRunTimeoutMinutes": {"type": "number", "minimum": 0, "default": 5}, "tsconfigFile": {"type": "string", "default": "tsconfig.json"}, "warnings": {"default": true, "oneOf": [{"type": "boolean"}, {}]}, "disableBail": {"type": "boolean", "default": false}, "allowEmpty": {"type": "boolean", "default": false}}}
stryker-core.json
command
The command to test each mutant. For example "npm run mocha". Defaults to "npm test".
{"type": "string", "default": "npm test"}
stryker-core.json
allowColor
Indicates whether or not to use color coding in output.
{"type": "boolean", "default": true}
stryker-core.json
allowEmojis
Enable emojis in your clear text report (experimental).
{"type": "boolean", "default": false}
stryker-core.json
logTests
Indicates whether or not to log which tests were executed for a given mutant.
{"type": "boolean", "default": true}
stryker-core.json
maxTestsToLog
Indicates the maximum amount of test to log when `logTests` is enabled
{"type": "integer", "minimum": 0, "default": 3}
stryker-core.json
project
Indicates which project to use if the "dashboard" reporter is enabled.
{"type": "string"}
stryker-core.json
version
Indicates which version to use if the "dashboard" reporter is enabled.
{"type": "string"}
stryker-core.json
module
Indicates which module to use if the "dashboard" reporter is enabled.
{"type": "string"}
stryker-core.json
baseUrl
Indicates the base url of the stryker dashboard.
{"type": "string", "default": "https://dashboard.stryker-mutator.io/api/reports"}
stryker-core.json
reportType
Indicates wether to send a full report (inc. source code and mutant results) or only the mutation score.
{"default": "full"}
stryker-core.json
baseDir
The base dir to write the events to
{"type": "string", "default": "reports/mutation/events"}
stryker-core.json
fileName
The `fileName` of the html report.
{"type": "string", "default": "reports/mutation/mutation.html"}
stryker-core.json
fileName
The relative filename for the json report.
{"type": "string", "default": "reports/mutation/mutation.json"}
stryker-core.json
plugins
Override the default babel plugins Stryker uses to parse your JavaScript files. The default list of plugins is extensive and normally doesn't need overriding. Stryker also loads your babel plugins by default (if you have them). If Stryker's default babel plugins conflicts with your plugins, try to override this list with an empty array.
{"anyOf": [{"type": "array", "items": {"type": ["string", "array"]}}, {"type": "null"}], "default": null}
stryker-core.json
unknownOptions
decide whether or not to log warnings when additional stryker options are configured
{"type": "boolean", "default": true}
stryker-core.json
preprocessorErrors
decide whether or not to log warnings when a preprocessor error occurs. For example, when the disabling of type errors fails.
{"type": "boolean", "default": true}
stryker-core.json
unserializableOptions
decide whether or not to log warnings when a configuration options are unserializable. For example, using a `/regex/` or `function` in your configuration options.
{"type": "boolean", "default": true}
stryker-core.json
slow
decide whether or not to log warnings when Stryker detects a slow part of mutation that can be sped up by changing some configuration. For example using `--ignoreStatic`.
{"type": "boolean", "default": true}
stryker-core.json
allowConsoleColors
The 'allowConsoleColors' value indicates whether Stryker should use colors in console.
{"type": "boolean", "default": true}
stryker-core.json
buildCommand
Configure a build command to run after mutating the code, but before mutants are tested. This is generally used to transpile your code before testing. Only configure this if your test runner doesn't take care of this already and you're not using just-in-time transpiler like `babel/register` or `ts-node`.
{"type": "string", "examples": ["tsc -b", "babel src --out-dir lib", "npm run build"]}
stryker-core.json
checkers
Enable checker plugins here. A checker plugin will be invoked for each mutant before it is run in a test runner. It can check to see of a given mutant is valid, by for example validate that it won't result in a type error
{"type": "array", "items": {"type": "string"}, "default": []}
stryker-core.json
checkerNodeArgs
Configure arguments to be passed as exec arguments to the checker child process(es). For example, running Stryker with `--concurrency 1 --checkerNodeArgs --inspect-brk` will allow you to debug the checker child process. See `execArgv` of [`child_process.fork`](https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options)
{"type": "array", "default": [], "items": {"type": "string"}}
stryker-core.json
concurrency
Set the concurrency of workers. Stryker will always run checkers and test runners in parallel by creating worker processes (note, not `worker_threads`). This defaults to `n-1` where `n` is the number of logical CPU cores available on your machine, unless `n <= 4`, in that case it uses `n`. This is a sane default for most use cases.
{"type": "number"}
stryker-core.json
commandRunner
Options used by the command test runner. Note: these options will only be used when the command test runner is activated (this is the default)
{"default": {}}
stryker-core.json
coverageAnalysis
Indicates which coverage analysis strategy to use. During mutation testing, Stryker will try to only run the tests that cover a particular mutant. 'perTest': Analyse coverage per test. 'all': Analyse the coverage for the entire test suite. 'off' (default): Don't use coverage analysis
{"default": "perTest"}
stryker-core.json
clearTextReporter
The options for the clear text reporter.
{"default": {}}
stryker-core.json
dashboard
The options for the dashboard reporter.
{"default": {}}
stryker-core.json
dryRunOnly
Execute the initial test run only without doing actual mutation testing. Dry run only will still mutate your code before doing the dry run without those mutants being active, thus can be used to test that StrykerJS can run your test setup. This can be useful, for example, in CI pipelines.
{"type": "boolean", "default": false}
stryker-core.json
eventReporter
The options for the event recorder reporter.
{"default": {}}
stryker-core.json
ignorePatterns
A comma separated list of patterns used for specifying which files need to be ignored. This should only be used in cases where you experience a slow Stryker startup, because too many (or too large) files are copied to the sandbox that are not needed to run the tests. For example, image or movie directories. Note: This option will have NO effect when using the `--inPlace` option. The directories `node_modules`, `.git` and some others are always ignored. Example: `--ignorePatterns dist`. These patterns are ALWAYS ignored: [`node_modules`, `.git`, `/reports`, `*.tsbuildinfo`, `/stryker.log`, `.stryker-tmp`]. Because Stryker always ignores these, you should rarely have to adjust the `ignorePatterns` setting at all. This is useful to speed up Stryker by ignoring big directories/files you might have in your repo that has nothing to do with your code. For example, 1.5GB of movie/image files. Specify the patterns to all files or directories that are not used to run your tests and thus should NOT be copied to the sandbox directory for mutation testing. Each patterns in this array should be a [glob pattern](#usage-of-globbing-expressions-on-options). If a glob pattern starts with `/`, the pattern is relative to the current working directory. For example, `/foo.js` matches to `foo.js` but not `subdir/foo.js`. However to SELECT specific files TO BE mutated, you better use `--mutate`.
{"type": "array", "items": {"type": "string"}, "default": []}
stryker-core.json
ignoreStatic
Ignore static mutants. Static mutants are mutants which are only executed during the loading of a file. This means that Stryker has to reload the entire environment in order to test the mutant AND has to run all tests. Therefore, it might make sense to ignore static mutants.
{"type": "boolean", "default": false}
stryker-core.json
incremental
Enable 'incremental mode'. Stryker will store results in a file and use that file to speed up the next --incremental run
{"type": "boolean", "default": false}
stryker-core.json
incrementalFile
Specify the file to use for incremental mode.
{"type": "string", "default": "reports/stryker-incremental.json"}
stryker-core.json
force
Run all mutants, even if --incremental is provided and an incremental file exists. Can be used to force a rebuild of the incremental file.
{"type": "boolean", "default": false}
stryker-core.json
fileLogLevel
Set the log level that Stryker uses to write to the "stryker.log" file
{"default": "off"}
stryker-core.json
inPlace
Determines whether or not Stryker should mutate your files in place. Note: mutating your files in place is generally not needed for mutation testing, unless you have a dependency in your project that is really dependent on the file locations (like "app-root-path" for example). When `true`, Stryker will override your files, but it will keep a copy of the originals in the temp directory (using `tempDirName`) and it will place the originals back after it is done. Also with `true` the `ignorePatterns` has no effect any more. When `false` (default) Stryker will work in the copy of your code inside the temp directory.
{"type": "boolean", "default": false}
stryker-core.json
logLevel
Set the log level that Stryker uses to write to the console.
{"default": "info"}