description: Field names a projection of a document location. They may include '/', but cannot begin or end with one. Many Fields are automatically inferred by Flow from a collection JSON Schema, and are the JSON Pointer of the document location with the leading '/' removed. User-provided Fields which act as a logical partitions are restricted to Unicode letters, numbers, '-', '_', or '.'

key: Field


type: array

type: object

description: Partition field names and values which are excluded from the source collection. Any documents matching *any one* of the partition values will be excluded.

description: Partition field names and corresponding values which must be matched from the Source collection. Only documents having one of the specified values across all specified partition names will be matched. For example, source: [App, Web] region: [APAC] would mean only documents of 'App' or 'Web' source and also occurring in the 'APAC' region will be processed.

description: Partition selectors identify a desired subset of the available logical partitions of a collection.

a_partition: A B

key: PartitionSelector


type: string

description: Test names are paths of Unicode letters, numbers, '-', '_', or '.'. Each path component is separated by a slash '/', and a name may not begin or end in a '/'.

key: Test


description:
A schema is a draft 2020-12 JSON Schema which validates Flow documents. Schemas also provide annotations at document locations, such as reduction strategies for combining one document into another.

Schemas may be defined inline to the catalog, or given as a relative or absolute URI. URIs may optionally include a JSON fragment pointer that locates a specific sub-schema therein.

For example, "schemas/marketing.yaml#/$defs/campaign" would reference the schema at location {"$defs": {"campaign": ...}} within ./schemas/marketing.yaml.

type: integer

key: Schema


description: Collection names are paths of Unicode letters, numbers, '-', '_', or '.'. Each path component is separated by a slash '/', and a name may not begin or end in a '/'.

key: Collection


description: Materialization names are paths of Unicode letters, numbers, '-', '_', or '.'. Each path component is separated by a slash '/', and a name may not begin or end in a '/'.

key: Materialization


description: The ring buffer is a performance optimization only: catalog tasks will replay portions of journals as needed when messages aren't available in the buffer. It can remain small if upstream task transactions are small, but larger transactions will achieve better performance with a larger ring. If not set, a reasonable default (currently 65,536) is used. EXPERIMENTAL: this field is LIKELY to be removed.

title: Size of the ring buffer used to sequence documents for exactly-once semantics.

description: Hot standbys of a shard actively replicate the shard's state to another machine, and are able to be quickly promoted to take over processing for the shard should its current primary fail. If not set, then no hot standbys are maintained. EXPERIMENTAL: this field MAY be removed.

title: Number of hot standbys to keep for each task shard.

description: Log levels may currently be "error", "warn", "info", "debug", or "trace". If not set, the effective log level is "info".

title: Log level of this tasks's shards.

description: This duration upper-bounds the amount of time during which a transaction may process documents before it must flush and commit. It may run for less time if there aren't additional ready documents for it to process. If not set, the maximum duration defaults to five minutes for materializations, and one second for captures and derivations. EXPERIMENTAL: this field MAY be removed.

title: Maximum duration of task transactions.

type: boolean

title: Disable processing of the task's shards.

description: Larger values are recommended for tasks having more than one shard split and long, bursty transaction durations. If not set, a reasonable default (currently 4,096) is used. EXPERIMENTAL: this field is LIKELY to be removed.

title: Size of the reader channel used for decoded documents.

description: This duration lower-bounds the amount of time during which a transaction must process documents before it must flush and commit. It may run for more time if additional documents are available. The default value is zero seconds. Larger values may result in more data reduction, at the cost of more latency. EXPERIMENTAL: this field MAY be removed.

title: Minimum duration of task transactions.

description: A ShardTemplate configures how shards process a catalog task.

key: ShardTemplate


description: JSON Pointer which identifies a location in a document.

key: JsonPointer


description: A test step describes either an "ingest" of document fixtures into a collection, or a "verify" of expected document fixtures from a collection.

[A] document

another: document

key: TestDocuments


required: config image

description: Connector image and configuration specification.

title: Image of the connector.

title: Configuration of the connector.

key: ConnectorConfig


description: A URL identifying a resource, which may be a relative local path with respect to the current resource (i.e, ../path/to/flow.yaml), or may be an external absolute URL (i.e., http://example/flow.yaml).

key: RelativeUrl


enum: boolean integer string

description: Type of a shuffled key component.

key: ShuffleType


description: Settings to determine how Flow should stay abreast of ongoing changes to collections and schemas.

description: Automatically add new bindings discovered from the source.

description: Whether to automatically evolve collections and/or materialization bindings to handle changes to collections that would otherwise be incompatible with the existing catalog.

key: AutoDiscover


description: Migrations may be provided as an inline string, or as a relative URL to a file containing the migration SQL.

title: Ordered migrations which are used to initialize the database.

key: DeriveUsingSqlite


enum: NONE GZIP ZSTANDARD SNAPPY GZIP_OFFLOAD_DECOMPRESSION

description: A CompressionCodec may be applied to compress journal fragments before they're persisted to cloud stoage. The compression applied to a journal fragment is included in its filename, such as ".gz" for GZIP. A collection's compression may be changed at any time, and will affect newly-written journal fragments.

key: CompressionCodec


enum: bintray custom generic github s3 spaces

title: PublishProvider

key: PublishProvider


description:
[DigitalOcean Spaces](https://www.digitalocean.com/community/tutorials/an-introduction-to-digitalocean-spaces) options.
Access key is required, define `DO_KEY_ID` and `DO_SECRET_KEY` environment variables.

title: SpacesOptions

required: name provider region

description: The space name.

description: The region (e.g. `nyc3`).

default: public-read

enum: private public-read

description: The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822).

description: The provider. Must be `spaces`.

description: The directory path.

description:
Whether to publish auto update info files.

Auto update relies only on the first provider in the list (you can specify several publishers).
Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.

default: latest

description: The update channel.

key: SpacesOptions


description:
Generic (any HTTP(S) server) options.
In all publish options [File Macros](/file-patterns#file-macros) are supported.

title: GenericServerOptions

required: provider url

description: The base url. e.g. `https://bucket_name.s3.amazonaws.com`.

description: Whether to use multiple range requests for differential update. Defaults to `true` if `url` doesn't contain `s3.amazonaws.com`.

description: The provider. Must be `generic`.

description: The channel.

key: GenericServerOptions


description: The [glob patterns](/file-patterns).

description: The destination path relative to the app's content directory for `extraFiles` and the app's resource directory for `extraResources`.

description: The source path relative to the project directory.

title: FileSet

key: FileSet


description: The arch or list of archs.

description: The target name. e.g. `snap`.

title: TargetConfiguration

key: TargetConfiguration


description:
File associations.

macOS (corresponds to [CFBundleDocumentTypes](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-101685)) and NSIS only.

On Windows works only if [nsis.perMachine](https://electron.build/configuration/configuration#NsisOptions-perMachine) is set to `true`.

title: FileAssociation

description: *linux-only.* The mime-type.

description: *macOS-only* Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`.

description: *windows-only.* The description.

description: The extension (minus the leading period). e.g. `png`.

default: Editor

description: *macOS-only* The app's role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`.

description:
The path to icon (`.icns` for MacOS and `.ico` for Windows), relative to `build` (build resources directory). Defaults to `${firstExt}.icns`/`${firstExt}.ico` (if several extensions specified, first is used) or to application icon.

Not supported on Linux, file issue if need (default icon will be `x-office-document`).

description: The name. e.g. `PNG`. Defaults to `ext`.

key: FileAssociation


description: Allows external asar files.

description: Whether to automatically unpack executables files.

title: AsarOptions

key: AsarOptions


default: build

description:
The path to build resources.

Please note — build resources is not packed into the app. If you need to use some files, e.g. as tray icon, please include required files explicitly: `"files": ["**\/*", "build/icon.*"]`

description: The application directory (containing the application package.json), defaults to `app`, `www` or working directory.

description: The output directory. [File macros](/file-patterns#file-macros) are supported.

title: MetadataDirectories

key: MetadataDirectories


type: number

description: The Y position relative to top of the screen.

description: The width. Defaults to background image width or 540.

description: The X position relative to left of the screen.

description: The height. Defaults to background image height or 380.

title: DmgWindow

key: DmgWindow


title: PlugDescriptor

key: PlugDescriptor


description:
[Bintray](https://bintray.com/) options. Requires an API key. An API key can be obtained from the user [profile](https://bintray.com/profile/edit) page ("Edit Your Profile" -> API Key).
Define `BT_TOKEN` environment variable.

title: BintrayOptions

description: The Bintray package name.

description: The Bintray component (Debian only).

default: generic

description: The Bintray repository name.

description: The Bintray user account. Used in cases where the owner is an organization.

description: The provider. Must be `bintray`.

description: The owner.

default: stable

description: The Bintray distribution (Debian only).

description:
Whether to publish auto update info files.

Auto update relies only on the first provider in the list (you can specify several publishers).
Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.

key: BintrayOptions


required: x y

description: The path of the file within the DMG.

enum: dir file link

description: The name of the file within the DMG. Defaults to basename of `path`.

title: DmgContent

key: DmgContent


description: The [cache location](https://github.com/electron-userland/electron-download#cache-location).

enum: darwin linux mas win32

description: The mirror.

title: ElectronDownloadOptions

key: ElectronDownloadOptions


description: The release date.

description: The release name.

description: The release notes.

description: The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform — `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](#MetadataDirectories-buildResources).

title: ReleaseInfo

key: ReleaseInfo


title: PkgBackgroundOptions

description: Options for the background image in a PKG installer

default: tofit

enum: none proportional tofit

description:
Scaling of the background image.
Options are: tofit, none, proportional

description: Path to the image to use as an installer background.

default: center

enum: bottom bottomleft bottomright center left right top topleft topright

description:
Alignment of the background image.
Options are: center, left, right, top, bottom, topleft, topright, bottomleft, bottomright

key: PkgBackgroundOptions


description:
URL Protocol Schemes. Protocols to associate the app with. macOS only.

Please note — on macOS [you need to register an `open-url` event handler](http://electron.atom.io/docs/api/app/#event-open-url-macos).

title: Protocol

required: name schemes

description: The schemes. e.g. `["irc", "ircs"]`.

enum: Editor None Shell Viewer

description: *macOS-only* The app's role with respect to the type.

description: The name. e.g. `IRC server URL`.

key: Protocol


required: bucket provider

description:
The endpoint URI to send requests to. The default endpoint is built from the configured region.
The endpoint should be a string like `https://{service}.{region}.amazonaws.com`.

description: Server-side encryption algorithm to use for the object.

description: The region. Is determined and set automatically when publishing.

description: The bucket name.

description:
The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822).

Please see [required permissions for the S3 provider](https://github.com/electron-userland/electron-builder/issues/1618#issuecomment-314679128).

default: STANDARD

description: The type of storage to use for the object.

description: The provider. Must be `s3`.

description: The directory path.

description: The update channel.

title: S3Options


description:
[GitHub](https://help.github.com/articles/about-releases/) options.

GitHub [personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) is required. You can generate by going to [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new). The access token should have the repo scope/permission.
Define `GH_TOKEN` environment variable.

title: GithubOptions

default: https

enum: http https

description: The protocol. GitHub Publisher supports only `https`.

default: draft

enum: draft prerelease release

description:
The type of release. By default `draft` release will be created.

Also you can set release type using environment variable. If `EP_DRAFT`is set to `true` — `draft`, if `EP_PRE_RELEASE`is set to `true` — `prerelease`.

description: The access token to support auto-update from private github repositories. Never specify it in the configuration files. Only for [setFeedURL](/auto-update#appupdatersetfeedurloptions).

description: Whether to use private github auto-update provider if `GH_TOKEN` environment variable is defined. See [Private GitHub Update Repo](/auto-update#private-github-update-repo).

description: The repository name. [Detected automatically](#github-repository-and-bintray-package).

description: The host (including the port if need).

description: The provider. Must be `github`.

description: The owner.

description: Whether to use `v`-prefixed tag name.

key: GithubOptions


description: Encryption settings. Only applies to client side, and only accepts "none" for now.

description: Flow settings.

description: ID of the account, in the form of a UUID, e.g., "66ad4540-b58c-4ad2-9926-ea63445a9b57".


description: TrojanUserConfig is user configuration


enum: none srtp utp wechat-video dtls wireguard


key: Toleration


key: VsphereVirtualDiskVolumeSource


key: QuobyteVolumeSource


key: AzureFileVolumeSource


key: PhotonPersistentDiskVolumeSource


key: IssueTrackerConfig


key: PersistentVolumeClaimVolumeSource


key: AWSElasticBlockStoreVolumeSource


key: PortworxVolumeSource


key: ConfigMapKeySelector


key: AzureDiskVolumeSource


key: GCEPersistentDiskVolumeSource


key: FCVolumeSource


key: SecretKeySelector


key: NFSVolumeSource


key: GlusterfsVolumeSource


key: GitRepoVolumeSource


key: PreviewEnvironmentConfig


key: ChatConfig


key: ServiceAccountTokenProjection


title: path

key: Url


pattern: ^[nvxsomilct]+$

key: vim-mode-key-pattern-string


description: If {repo} starts with github user name (ex:'Shougo/dein.vim'), dein will install github plugins.

title: repo name pattern

key: repo-string-pattern


title: path

key: Path


description: Console command name

title: Command name

key: commands


description: CVar name

title: Variable name

key: cvars


description: The environment that the job references

description: A deployment URL

description: The name of the environment configured in the repo.

key: environment


$comment: escape `{` and `}` in pattern to be unicode compatible (#1360)

key: expressionSyntax


key: stringContainingExpressionSyntax


description: Using the working-directory keyword, you can specify the working directory of where to run the command.

key: working-directory


enum: bash pwsh python sh cmd powershell

description: You can override the default shell settings in the runner's operating system using the shell keyword. You can use built-in shell keywords, or you can define a custom set of shell options.

key: shell


description:
Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.

key: types