schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
host.json
concurrency
Configuration settings for dynamic concurrency
{"type": "object", "properties": {"dynamicConcurrencyEnabled": {"type": "boolean", "default": true}, "snapshotPersistenceEnabled": {"type": "boolean", "default": true}}, "additionalProperties": false}
host.json
dynamicConcurrencyEnabled
Enables or disables dynamic concurrency for function apps.
{"type": "boolean", "default": true}
host.json
snapshotPersistenceEnabled
Enables or disables the learned concurrency values persisting in storage.
{"type": "boolean", "default": true}
cryproj.54.schema.json
cvars
CVar name
{"type": "string", "default": "sys_target_platforms", "enum": ["a_poseAlignerDebugDraw", "a_poseAlignerEnable", "a_poseAlignerForceLock", "a_poseAlignerForceNoIntersections", "a_poseAlignerForceNoRootOffset", "a_poseAlignerForceTargetSmoothing", "a_poseAlignerForceWeightOne", "ac_ColliderModeAI", "ac_ColliderModePlayer...
cryproj.54.schema.json
commands
Console command name
{"type": "string", "default": "", "enum": ["_TestFormatMessage", "ai_CheckGoalpipes", "ai_commTest", "ai_commTestStop", "ai_DebugAgent", "ai_debugMNMAgentType", "ai_dumpCheckpoints", "ai_MNMCalculateAccessibility", "ai_MNMComputeConnectedIslands", "ai_NavigationReloadConfig", "ai_Recorder_Start", "ai_Recorder_Stop", "a...
cryproj.54.schema.json
value
The default value of the CVar
{"type": "string", "default": "pc,ps4,xboxone,linux"}
cryproj.54.schema.json
items
This indicates where the assets are stored
{"type": "string", "default": "Assets", "examples": ["Assets"]}
cryproj.54.schema.json
items
This indicates where the code is stored
{"type": "string", "default": "Code", "examples": ["Code"]}
cryproj.54.schema.json
name
This indicates the project name
{"type": "string", "default": "", "examples": ["MyFancyProject"]}
cryproj.54.schema.json
engine
This indicates which engine version will be used
{"type": "string", "default": "", "examples": ["engine-5.4"], "enum": ["engine-5.4"]}
cryproj.54.schema.json
path
Required plugin's name
{"type": "string", "examples": ["CryDefaultEntities", "CrySensorSystem", "CryPerceptionSystem", "CryUserAnalytics", "CryOSVR", "CryOculusVR", "CryOpenVR", "CryLobby"]}
cryproj.54.schema.json
type
EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one
{"type": "string", "default": "", "examples": ["EPluginType::Native", "EPluginType::Managed"], "enum": ["EPluginType::Native", "EPluginType::Managed"]}
cryproj.54.schema.json
value
Arguments that has to be passed to the command. Leave empty if it has not parameters
{"type": "string", "default": ""}
ntangle.json
Root
The 'RootConfig' object defines the global properties that are used to drive the underlying database-driven CDC-oriented code-generation.
{"type": "object", "properties": {"schema": {"type": "string"}, "cdcSchema": {"type": "string"}, "cdcSchemaCreate": {"type": "boolean"}, "versionTrackingTable": {"type": "string"}, "cdcEnable": {"type": "boolean"}, "identifierMapping": {"type": "boolean"}, "identifierMappingType": {"type": "string", "enum": ["String", ...
ntangle.json
schema
This is used as the default 'Schema' for all child objects. Defaults to 'dbo' (literal).
{"type": "string"}
ntangle.json
cdcSchema
Defaults to 'NTangle' (literal).
{"type": "string"}
ntangle.json
cdcSchemaCreate
Defaults to 'false'.
{"type": "boolean"}
ntangle.json
versionTrackingTable
Defaults to 'VersionTracking' (literal).
{"type": "string"}
ntangle.json
cdcEnable
Defaults to 'false'. This option can be overridden for each underlying table referenced.
{"type": "boolean"}
ntangle.json
identifierMapping
Where set to 'true' each underlying 'Table' and corresponding 'Join' must set 'IdentifierMapping' explicitly.
{"type": "boolean"}
ntangle.json
identifierMappingType
Defaults to 'String'.
{"type": "string", "enum": ["String", "Int", "Long", "Guid"]}
ntangle.json
identifierMappingTable
Defaults to 'IdentifierMapping' (literal).
{"type": "string"}
ntangle.json
identifierMappingStoredProcedure
Defaults to 'spIdentifierMappingCreate' (literal).
{"type": "string"}
ntangle.json
isDeletedColumn
Defaults to 'IsDeleted'.
{"type": "string"}
ntangle.json
autoDotNetRename
Defaults to 'SnakeKebabToPascalCase' which will remove any underscores or hyphens separating each word and capitalize the first character of each; e.g. 'internal-customer_id' would be renamed as 'InternalCustomerId'. The 'PascalCase' option will capatilize the first character only.
{"type": "string", "enum": ["None", "PascalCase", "SnakeKebabToPascalCase"]}
ntangle.json
jsonSerializer
Defaults to 'SystemText'.
{"type": "string", "enum": ["SystemText", "Newtonsoft"]}
ntangle.json
service
Defaults to 'None'. A 'HostedService' is an 'IHostedService' implementation enabling long-running execution; whereas, 'Service' is intended for self-managed execution.
{"type": "string", "enum": ["None", "HostedService", "Service"]}
ntangle.json
eventSubjectRoot
Used to enable the sending of messages to the likes of EventHubs, Service Broker, Kafka, etc.
{"type": "string"}
ntangle.json
eventSubjectFormat
Defaults to 'NameOnly'.
{"type": "string", "enum": ["NameOnly", "NameAndKey", "NameAndTableKey"]}
ntangle.json
eventActionFormat
Defaults to 'None' (no formatting required, i.e. as-is).
{"type": "string", "enum": ["None", "PastTense"]}
ntangle.json
eventSourceKind
Defaults to 'Relative' (being a relative path).
{"type": "string", "enum": ["None", "Absolute", "Relative", "RelativeOrAbsolute"]}
ntangle.json
eventSourceRoot
The event source is only updated where an 'EventSourceKind' is not 'None'.
{"type": "string"}
ntangle.json
eventSourceFormat
Defaults to 'NameAndTableKey' (being the child 'Cdc.ModelName' appended with the corresponding table key).
{"type": "string", "enum": ["NameOnly", "NameAndKey", "NameAndTableKey"]}
ntangle.json
eventTypeRoot
Used to enable the sending of messages to the likes of EventHubs, Service Broker, Kafka, etc. Defaults to 'EventSubjectRoot'.
{"type": "string"}
ntangle.json
outbox
Defaults to 'false'.
{"type": "boolean"}
ntangle.json
outboxSchema
Defaults to 'Outbox' (literal).
{"type": "string"}
ntangle.json
outboxSchemaCreate
Defaults to 'false'.
{"type": "boolean"}
ntangle.json
outboxTable
Defaults to 'EventOutbox' (literal).
{"type": "string"}
ntangle.json
outboxEnqueueStoredProcedure
Defaults to 'spEventOutboxEnqueue' (literal).
{"type": "string"}
ntangle.json
outboxDequeueStoredProcedure
Defaults to 'spEventOutboxDequeue' (literal).
{"type": "string"}
ntangle.json
pathBase
Defaults to 'AppName' (runtime parameter). For example 'Avanade.Application'.
{"type": "string"}
ntangle.json
pathDatabase
Defaults to 'PathBase' + '.Database' (literal). For example 'Avanade.Application.Database'.
{"type": "string"}
ntangle.json
pathDatabaseSchema
Defaults to 'PathDatabase' + '/Schema' (literal). For example 'Avanade.Application.Database/Schema'.
{"type": "string"}
ntangle.json
pathDatabaseMigrations
Defaults to 'PathDatabase' + '/Migrations' (literal). For example 'Avanade.Application.Database/Migrations'.
{"type": "string"}
ntangle.json
pathDotNetPublisher
Defaults to 'PathBase' + '.Publisher' (literal). For example 'Avanade.Application.Publisher'.
{"type": "string"}
ntangle.json
namespaceBase
Defaults to 'AppName' (runtime parameter). For example 'Avanade.Application'.
{"type": "string"}
ntangle.json
namespacePublisher
Defaults to 'NamespaceBase' + '.Publisher' (literal). For example 'Avanade.Application.Publisher'.
{"type": "string"}
ntangle.json
namespaceOutbox
Defaults to 'NamespacePublisher'.
{"type": "string"}
ntangle.json
tables
A 'Table' object provides the primary database table configuration for Change Data Capture (CDC), including multiple child table joins to form a composite entity.
{"type": "array", "items": {}}
ntangle.json
Table
The 'Table' object enables the definition of the primary table, one-or-more child tables and their respective join relationships, to enable Change Data Capture (CDC) event publishing. The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing ...
{"type": "object", "properties": {"name": {"type": "string"}, "schema": {"type": "string"}, "table": {"type": "string"}, "alias": {"type": "string"}, "includeColumns": {"type": "array", "items": {"type": "string"}}, "excludeColumns": {"type": "array", "items": {"type": "string"}}, "aliasColumns": {"type": "array", "ite...
ntangle.json
schema
Defaults to 'Root.Schema'.
{"type": "string"}
ntangle.json
table
Defaults to 'Name'. This is used to specify the actual underlying database table name (required where the 'Name' has been changed to enable uniqueness).
{"type": "string"}
ntangle.json
alias
Will automatically default where not specified; for example a table named 'Person' will default to 'p'.
{"type": "string"}
ntangle.json
includeColumns
Where not specified this indicates that all 'Columns' are to be included.
{"type": "array", "items": {"type": "string"}}
ntangle.json
excludeColumns
Where not specified this indicates no 'Columns' are to be excluded.
{"type": "array", "items": {"type": "string"}}
ntangle.json
aliasColumns
Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'.
{"type": "array", "items": {"type": "string"}}
ntangle.json
executeStoredProcedure
Defaults to 'sp' (literal) + 'Name' + 'BatchExecute' (literal); e.g. 'spNameBatchExecute'.
{"type": "string"}
ntangle.json
completeStoredProcedure
Defaults to 'sp' (literal) + 'Name' + 'BatchComplete' (literal); e.g. 'spNameBatchComplete'.
{"type": "string"}
ntangle.json
cdcSchema
Defaults to 'Root.CdcSchema'.
{"type": "string"}
ntangle.json
batchTrackingTable
Defaults to 'Name' + 'BatchTracking' (literal).
{"type": "string"}
ntangle.json
cdcEnable
Defaults to 'false'. This option can be overridden for each underlying table referenced.
{"type": "boolean"}
ntangle.json
model
Defaults to 'Name'.
{"type": "string"}
ntangle.json
orchestratorCtorParams
Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred.
{"type": "array", "items": {"type": "string"}}
ntangle.json
database
Defaults to 'IDatabase'.
{"type": "string"}
ntangle.json
includeColumnsOnDelete
Where a column is not specified in this list its corresponding .NET property will be automatically cleared by the 'CdcDataOrchestrator' as the data is technically considered as non-existing.
{"type": "array", "items": {"type": "string"}}
ntangle.json
service
Defaults to 'Root.Service'. A 'HostedService' is an 'IHostedService' implementation enabling long-running execution; whereas, 'Service' is intended for self-managed execution.
{"type": "string", "enum": ["None", "HostedService", "Service"]}
ntangle.json
excludeColumnsFromETag
Defaults to 'Root.CdcExcludeColumnsFromETag'.
{"type": "array", "items": {"type": "string"}}
ntangle.json
partitionKey
A partition key can be specified using either 'PartitionKey' or 'PartitionKeyColumns'.
{"type": "string"}
ntangle.json
partitionKeyColumns
A partition key can be specified using either 'PartitionKey' or 'PartitionKeyColumns'.
{"type": "array", "items": {"type": "string"}}
ntangle.json
eventSource
Defaults to 'Schema' + '/' (literal) + 'Name' (as lowercase). Note: when used in code-generation the 'Root.EventSourceRoot' will be prepended where specified.
{"type": "string"}
ntangle.json
eventSourceFormat
Defaults to 'Root.EventSourceFormat'.
{"type": "string", "enum": ["NameOnly", "NameAndKey", "NameAndTableKey"]}
ntangle.json
eventSubject
Defaults to 'ModelName'. Note: when used in code-generation the 'Root.EventSubjectRoot' will be prepended where specified.
{"type": "string"}
ntangle.json
eventSubjectFormat
Defaults to 'Root.EventSubjectFormat'.
{"type": "string", "enum": ["NameOnly", "NameAndKey", "NameAndTableKey"]}
ntangle.json
eventType
Defaults to 'ModelName'. Note: when used in code-generation the 'Root.EventTypeRoot' will be prepended where specified.
{"type": "string"}
ntangle.json
identifierMapping
This indicates whether to create a new 'GlobalId' property on the _entity_ to house the global mapping identifier to be the reference outside of the specific database realm as a replacement to the existing primary key column(s).
{"type": "boolean"}
ntangle.json
identifierName
This indicates whether to create a new 'GlobalId' property on the _entity_ to house the global mapping identifier to be the reference outside of the specific database realm as a replacement to the existing primary key column(s).
{"type": "string"}
ntangle.json
isDeletedColumn
Defaults to 'Root.ColumnIsDeleted'.
{"type": "string"}
ntangle.json
joins
A 'Join' object provides the configuration for a table join.
{"type": "array", "items": {}}
ntangle.json
where
A 'Where' object provides the configuration for a table where clause.
{"type": "array", "items": {}}
ntangle.json
Join
The 'Join' object defines a join to another (or same) table within the logical CDC entity. The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required.
{"type": "object", "properties": {"name": {"type": "string"}, "schema": {"type": "string"}, "table": {"type": "string"}, "alias": {"type": "string"}, "type": {"type": "string", "enum": ["Cdc", "Inner", "Left", "Right", "Full"]}, "joinTo": {"type": "string"}, "joinCardinality": {"type": "string", "enum": ["OneToMany", "...
ntangle.json
name
A unique name is required where the same 'Table' is referenced more than once within a logical CDC entity. However, generally, this will represent the unique name of the table within the database.
{"type": "string"}
ntangle.json
schema
Defaults to 'Cdc.Schema'; i.e. same schema.
{"type": "string"}
ntangle.json
table
Defaults to 'Name'. This is used to specify the actual underlying database table name (required where the 'Name' has been changed to enable uniqueness).
{"type": "string"}
ntangle.json
alias
Will automatically default where not specified.
{"type": "string"}
ntangle.json
type
Defaults to 'Cdc'. The 'Cdc' value indicates this is a related secondary table (within a logical CDC entity) that also has Change Data Capture turned on and equally needs to be monitored for changes.
{"type": "string", "enum": ["Cdc", "Inner", "Left", "Right", "Full"]}
ntangle.json
joinTo
Defaults to parent 'Table.Name'.
{"type": "string"}
ntangle.json
joinCardinality
Defaults to 'OneToMany'. This represents the Parent ('JoinTo') to child (_this_) relationship.
{"type": "string", "enum": ["OneToMany", "OneToOne"]}
ntangle.json
cdcEnable
Defaults to 'false'. This option can be overridden for each underlying table referenced.
{"type": "boolean"}
ntangle.json
querySizeMultiplier
Defaults to '1.0'. This is applied to the execute stored procedure '@MaxQuerySize' parameter to allow tailoring on the join query ('TOP') sizes to optimize selection. Must be greater than zero and less than or equal to 100.
{"type": "number"}
ntangle.json
includeColumns
Where not specified this indicates that all 'Columns' are to be included.
{"type": "array", "items": {"type": "string"}}
ntangle.json
excludeColumns
Where not specified this indicates no 'Columns' are to be excluded.
{"type": "array", "items": {"type": "string"}}
ntangle.json
aliasColumns
Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'
{"type": "array", "items": {"type": "string"}}
ntangle.json
model
Defaults to 'Name'.
{"type": "string"}
ntangle.json
property
Defaults to 'Model' where 'JoinCardinality' is 'OneToOne'; otherwise, it will be the 'Model' pluralized.
{"type": "string"}
ntangle.json
includeColumnsOnDelete
Where a column is not specified in this list its corresponding .NET property will be automatically cleared by the 'CdcDataOrchestrator' as the data is technically considered as non-existing.
{"type": "array", "items": {"type": "string"}}
ntangle.json
excludeColumnsFromETag
Defaults to 'CodeGeneration.CdcExcludeColumnsFromETag'.
{"type": "array", "items": {"type": "string"}}
ntangle.json
identifierMapping
This indicates whether to create a new 'GlobalId' property on the _entity_ to house the global mapping identifier to be the reference outside of the specific database realm as a replacement to the existing primary key column(s).
{"type": "boolean"}
ntangle.json
identifierName
This indicates whether to create a new 'GlobalId' property on the _entity_ to house the global mapping identifier to be the reference outside of the specific database realm as a replacement to the existing primary key column(s).
{"type": "string"}
ntangle.json
JoinOn
The 'JoinOn' object defines the join on characteristics for a 'Join' object.
{"type": "object", "properties": {"name": {"type": "string"}, "toColumn": {"type": "string"}, "toStatement": {"type": "string"}}, "required": ["name"]}
ntangle.json
toColumn
Defaults to 'Name'; i.e. assumes same name.
{"type": "string"}