Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The following list describes the possible error and warning codes logged by the Common Data Model SDK with their description. These error and warning codes are defined in CdmLogcode enum class.
Errors
Enum | Description |
---|---|
ErrAdapterNotFound | SDK attempted to obtain adapter associated with namespace that the given document is part of, but couldn't find it. This error is usually reported after errors ErrStorageNullNamespace and ErrStorageAdapterNotFound. |
ErrCycleInObjectDefinition | SDK detected an object definition containing a cycle. This happens when an object definition tries to extend from itself. |
ErrDocAdapterNotFound | SDK attempted to obtain adapter associated with the namespace that the given document is part of, but couldn't find it. This error is usually reported after errors ErrStorageNullNamespace and ErrStorageAdapterNotFound. |
ErrDocEntityDocSavingFailure | SDK was unable to save documents containing definitions of local or partition-specialized entities. This error is usually reported after errors ErrValdnInvalidCorpusPath, ErrPersistObjectNotFound, and ErrDocEntityDocSavingFailure. |
ErrDocEntityReplacementFailure | This error occurs during resolution of an entity if the document where the resolved entity is going to be saved already exists. To avoid this error, you can specify non-conflicting resolved document name (if calling CreateResolvedEntityAsync ) or document rename pattern (if calling CreateResolvedManifestAsync ). |
ErrDocImportSavingFailure | SDK was unable to save one or more documents imported by the document currently being saved. This error is usually reported after errors ErrValdnInvalidCorpusPath, ErrPersistObjectNotFound, and ErrDocEntityDocSavingFailure. |
ErrDocIsNotFolder | This error occurs when one of the entities in a manifest being resolved is part of a document that isn't placed in any CDM virtual folder. This situation may occur when composing a new manifest and adding entities but omitting to place entity documents to a CDM folder before the resolution is started. |
ErrDocPartitionSchemaSavingFailure | SDK logs this error when it fails to save partition schema document. This error is usually reported after ErrValdnInvalidCorpusPath, ErrPersistObjectNotFound, or ErrDocEntityDocSavingFailure. |
ErrDocSubManifestSavingFailure | SDK logs this error when it fails to save submanifest document. This error usually reported after ErrValdnInvalidCorpusPath, ErrPersistObjectNotFound, or ErrDocEntityDocSavingFailure. |
ErrDocSymbolNotFound | This error is logged by FetchObjectAsync API when it isn't able to find the specified object. This error may happen if the supplied path is incorrect, or the document on the target file-system can't be loaded. |
ErrDocWrtDocNotfound | SDK logs this error when resolving an entity if WrtDoc property in the ResolveOptions object isn't set. The WRT stands for "with regard to" and is the document SDK should use as a point of reference when resolving relative paths and symbol names encountered in the definitions. |
ErrEntityCreationFailed | This error is logged during addition of an entity definition to a manifest if the supplied entity object doesn't have Owner set. An 'owner' for an entity definition object should be a document, therefore make sure to add entity definition to a document before the entity is added to a manifest. |
ErrEnumConversionFailure | This error is reported during conversion of a string to cdm enumeration value. A common situation is if the input string doesn't have its corresponding enumeration value. |
ErrFetchingFileMetadataNull | This error is reported when the FetchAllFilesMetadataAsync method of a Storage Adapter. This means the Storage Adapter needs to be configured correctly so that this method does not return null. |
ErrIndexFailed | This error is reported during document indexing process. A common situation is if a document object exists that has not been added to any folder object yet, indicated by the preceding ErrValdnMissingDoc error. |
ErrInvalidCast | This error is reported when fetching an object. If an object is fetched but that object (determined by the corpusPath that is passed in) is different than the type of object you are trying to instantiate, this error will be raised. For example, if a user calls FetchObjectAsync on a path that points to a CdmDocumentDefinition object but the type provided to the generic function is a CdmEntityDefinition, then this error will occur. The SDK will log this error if a call fails inside the SDK. In the C# SDK, if the error occurs when the user calls the FetchObjectAsync API, then this error will be logged. In all other languages, if there is an object mismatch an exception will be thrown and the user will need to capture and handle these errors. |
ErrInvalidPath | SDK logs this error when attempting to fetch child folders for the given path, but detects discrepancy between the indicated path names and the folder objects names, for example, path is "/foo/bar" but folders objects are defined as folder("foo").folder("qux"). |
ErrMissingIncrementalPartitionTrait | This error is reported during updating an Local Entity Declaration object. When SDK goes through the incremental partition collection or the incremental partition pattern collection, it logs this error if it encounters a partition definition or partition pattern definition that doesn't contain the incremental trait is.partition.incremental . All partition objects and partition pattern objects must have the incremental trait is.partition.incremental to be incremental. |
ErrObjectWithoutOwnerFound | SDK logs this error during searching for entity to entity relationships when object containing the target entity is missing. |
ErrPartitionFileMetadataFailure | This error is reported during fetching of file information for a partition file, when SDK accesses file-system via applicable adapter but encounters an exception, usually I/O related. Possible reasons can be wrong partition paths, wrong adapter configurations, access permissions, temporary network failures, and others. Inspect the exception to obtain root cause details. |
ErrPartitionFileModTimeFailure | This error is reported during computation of the last modified time of a partition, when SDK accesses file-system via applicable adapter but encounters an exception, usually I/O related. Possible reasons can be wrong partition paths, wrong adapter configurations, access permissions, temporary network failures, and others. Inspect the exception to obtain root cause details. |
ErrPathIsDuplicate | SDK logs this error during document indexing process if it encounters a definition identified by a name that was already declared in the same document, for example, by having definition of "Task" entity twice in the same document. |
ErrPathNullObjectPath | This error is logged when SDK needs to load a document, calculate file modification time or create absolute corpus path from the given corpus path, but encounters a path that is null or empty. Ensure your document paths and partition locations are properly set. The object path can't be null or empty. |
ErrPersistAdapterNotFoundForNamespace | While saving a document, SDK attempted to obtain the adapter associated with the namespace that a given document is part of, but couldn't find anything registered to this namespace. This error is usually reported after errors ErrStorageNullNamespace and ErrStorageAdapterNotFound. |
ErrPersistAdapterWriteFailure | SDK logs this error when adapter doesn't have permission to write, for example if attempting to save back a document that was loaded from CdmStandardsAdapter. |
ErrPersistCardinalityPropMissing | SDK logs this error when creating entity attribute object from the definition document and finds a cardinality object that is missing minimum or maximum value. Correct the document to specify both values. |
ErrPersistCdmEntityFetchError | This error is logged when SDK fails to obtain entity definition document indicated in the supplied path of a local entity declaration in a manifest. there's variety of possible root causes for this situation, so inspect the preceding logs reported by the SDK. |
ErrPersistClassMissing | SDK logs this error during loading or saving of a document when it can't recognize the document type. Supported document types are "*.cdm.json", " manifest.cdm.json" and "model.json". Supported formats are model.json, manifest.cdm.json, and cdm.json. |
ErrPersistConversionError | This error is a catch-all error reported on manifest object level, issued when performing load from the file-system. Inspect the contained exception message and any other prior error messages to find possible root cause. |
ErrPersistCsvProcessingError | SDK logs this error when cs format passed are incorrect or missing. Csv should have columnHeaders, csvstyle, delimiter, quoteStyle, and encoding. |
ErrPersistDeserializeError | SDK logs this error when entity fails to deserialize. Reason logged in message. Check eventlist object to get more granular error codes. |
ErrPersistDocConversionFailure | This error is a catch-all error reported on manifest object level, issued when performing load from the file-system. Inspect the contained exception message and any other prior error messages to find possible root cause. |
ErrPersistDocNameLoadFailure | This error is logged while loading a document with an invalid file name. This is specific to model.json files, which must be named exactly that, any other file name, for example "foo.model.json", will get rejected. |
ErrPersistEntityAttrUnsupported | While loading entity, SDK found both a Projection and a Resolution Guidance set on the same entity attribute. In this situation, Projection takes precedence and the Resolution Guidance is skipped. |
ErrPersistEntityDeclarationMissing | This error is logged if a manifest document contains a declaration with non-recognizable "type" property value. The only supported entity declaration types are "LocalEntity" or "ReferencedEntity". |
ErrPersistIncrementalConversionError | SDK logs this error during loading or saving of a document when it encounters a partition object (or partition pattern object) in the data partition collection (or the data partition pattern collection) that contains the incremental trait is.partition.incremental . All incremental partition objects and non-incremental partition pattern objects must be added to incremental partition collection and incremental partition pattern collection respectively. |
ErrPersistEntityPathNotFound | The SDK will log this error if entity path isn't set in the entity declaration in the document being loaded. Check the document content and add missing path(s). |
ErrPersistFailure | This error is logged while saving a document with an invalid file name. This is specific to model.json files, which must be named exactly that, any other file name, for example "foo.model.json", will get rejected. |
ErrPersistFilePersistError | This error is a catch-all error that is logged if any exception is encountered during saving of a document. Inspect the contained exception message and any other prior error messages to find possible root cause. |
ErrPersistFilePersistFailed | This error is a catch-all error reported in case SDK isn't able to serialize a document. Inspect prior error messages to find possible root cause. |
ErrPersistFileReadFailure | SDK logs this error when attempting to load a document from a file-system via corresponding adapter, but encounters an exception. This error is usually I/O related and possible root cause may be found in the exception details. |
ErrPersistFileWriteFailure | SDK has encountered error(s) while saving the specified document. The common reasons include object serialization errors, I/O errors, invalid object paths, or adapter configuration saving errors. Inspect the contained exception message and any other prior error messages to find possible root cause. |
ErrPersistInvalidMaxCardinality | SDK logs this error when it tries to create entity attribute object but fails because of invalid maximum cardinality value. Ensure the value must be a number greater than zero or "*". |
ErrPersistInvalidMinCardinality | SDK logs this error when it tries to create entity attribute object but fails because of invalid minimum cardinality value. Ensure the value is greater than or equal to 0 and less than maximum cardinality. |
ErrPersistJsonAttrContextConversionError | SDK logs this error when it isn't able to deserialize from JSON to an attribute context object. Inspect the contained exception message to find possible root cause. |
ErrPersistJsonDatatypeConversionError | SDK logs this error when it isn't able to deserialize from JSON to a data type object because the JSON is null. |
ErrPersistJsonDatatypeRefConversionError | SDK logs this error when it isn't able to deserialize from JSON to a data type reference object. Inspect the contained exception message to find possible root cause. |
ErrPersistJsonImportConversionError | SDK logs this error when it isn't able to deserialize from JSON to an import declaration object because the JSON is null. |
ErrPersistJsonObjectRefConversionError | SDK logs this error when it isn't able to serialize reference objects to JSON. Inspect the contained exception message to find possible root cause. |
ErrPersistModelJsonDocConversionError | SDK logs this error when data partition object creation fails for the entity. |
ErrPersistModelJsonEntityAttrError | This error occurs if a manifest containing an entity that has an entity attribute is saved to model.json format. This may happen if attempting to save a manifest containing one or more logical (non-resolved) entity definitions. Please make sure only resolved entities are saved to model.json form. |
ErrPersistModelJsonEntityConversionError | SDK logs this error when it tries to create model.json document but fails to load relationship. Please check entitylist object for more granular error code causing this. |
ErrPersistModelJsonEntityDeclarationConversionError | This is a catch-all error which is logged when SDK encounters a problem when converting entity (declaration) to model.json format. Possible reasons include ErrPersistInvalidEntityPath and ErrPersistModelIdDuplication. Please inspect prior error messages to find possible root cause. |
ErrPersistModelJsonEntityDeclarationConversionFailure | This is a catch-all error which is logged when SDK encounters an exception when converting entity (declaration) to model.json format. Please inspect the contained exception message to find possible root cause. |
ErrPersistModelJsonRefEntityInvalidLocation | This error is logged if the location in the model.json file for an entity isn't understood by any storage adapter. Either the location value is incorrect or an adapter that can understand the location path needs to be mounted. |
ErrPersistModelJsonEntityParsingError | This error is logged if a model.json file being loaded contains entities with invalid "type" property, or if other problems occurred reading the entity information. The only supported model.json entity types are "LocalEntity" and "ReferenceEntity". |
ErrPersistModelJsonEntityRefConversionError | SDK logs this error when reference entity path isn't valid. |
ErrPersistModelJsonFromAttrConversionFailure | SDK logs this error when it tries to create cdm document object from CDM object but fails. Check entitylist object for more granular error code causing this. |
ErrPersistModelJsonInvalidEntityPath | SDK logs this error when conversion from corpus path to adapter path failed during creation of manifest document from CDM object. |
ErrPersistModelJsonInvalidExtensionTrait | This error is logged during loading of a model.json file, if an extension trait with an invalid name is encountered. All model.json extension traits must have prefix "is.extension". in their names. |
ErrPersistModelJsonModelIdDuplication | SDK logs this error when loading model.json file if same reference model ID is pointing at different locations. Use unique IDs in all declared reference models. |
ErrPersistModelJsonModelIdNotFound | SDK logs this error when loading model.json file if a specified reference ID isn't declared in the list of reference models. Ensure any reference ID used in the model.json is declared with an appropriate path under the "referenceModels" section. |
ErrPersistModelJsonToAttrConversionFailure | SDK logs this error when it tries to create CDM object from document but fails. Check entitylist object for more granular error code causing this. |
ErrPersistNonIncrementalConversionError | SDK logs this error during loading or saving of a document when it encounters a partition object (or partition pattern object) in the data partition collection (or the data partition pattern collection) that contains the incremental trait is.partition.incremental . All non-incremental partition objects and non-incremental partition pattern objects must not have the incremental trait is.partition.incremental . |
ErrPersistNullDocName | This error gets logged if SDK finds a document with a null or empty name while performing loading or saving activity. All document objects must have a name set. Document name can't be null or empty. |
ErrPersistObjectNotFound | SDK logs this error when performing loading or saving of documents, if the specified path isn't pointing at a valid document. Generally this happens if SDK is asked to load an invalid path, or save a document that has an import pointing at an invalid path. When investigating this problem, look for prior logged errors such as ErrPathNullObjectPath, ErrStorageNamespaceMismatch, ErrStorageInvalidPathFormat, ErrValdnInvalidDoc, and ErrDocSymbolNotFound. |
ErrPersistProjInvalidOpsType | SDK logs this error if an invalid "$type" is provided on a projection operation. Consult here for a list of valid operation type values. |
ErrPersistProjUnsupportedProp | This error is reported during loading of documents if an entity definition's attribute has a renameAttributes operation where "applyTo" property is neither a String value nor a List of String values. Update the definition with correct "applyTo" value. |
ErrPersistSymsAdlsAdapterMissing | SDK logs this error when no ADLS adapter has been found to match data location while reading entity information from SyMS. In some cases, this may be a transient issue and a retry can fix it. |
ErrPersistSymsAdlsAdapterNotMounted | SDK logs this error when it fails to create/mount ADLS adapter using "is.storagesource" trait and the SyMS adapter path. Common cause is when prefix adls1 to adls100 all are occupied. In some cases, this may be a transient issue and a retry can fix it. |
ErrPersistSymsAttrConversionFailure | SDK logs this error when it fails to convert SyMS column into attribute for an entity. Inspect prior errors reported in the log. |
ErrPersistSymsAttrConversionError | SDK logs this error while reading from SyMS when SyMS storage descriptor or its column received was null. Check SyMS database. |
ErrPersistSymsEntityFetchError | SDK logs this error when it fails to fetch entity before writing to SyMS because entity path was invalid. Check entity paths in manifest. |
ErrPersistSymsEntityPathNull | SDK logs this error when it fails to fetch entity before writing to SyMS because entity path was null. Check if entity path is missing in the manifest. |
ErrPersistSymsEntityDeclConversionFailure | SDK logs this error when it fails to create a SyMS entity object from CDM entity declaration. Check the exception message and prior errors reported in the log. |
ErrPersistSymsEntityDeclConversionException | SDK logs this error when it fails to create an SyMS entity object from CDM entity declaration because of unexpected exception. Check exception message. |
ErrPersistSymsMultipleOrZeroTableDefinition | SDK supports only one entity definition in document for CDM-SyMs conversion. |
ErrPersistSymsInvalidDbPropObject | SDK logs this error when it gets null database or database location from SyMS. |
ErrPersistSymsInvalidDbObject | SDK logs this error when it expect database type object but receive different type of object other than table from SyMS. |
ErrPersistSymsIncompatibleFileToType | SDK logs this error when SyMS returns file type and format which are incompatible with each other. Please check SyMS database metadata and error message returned from caller. |
ErrPersistSymsRelationshipTypeNotSupported | SDK logs this error when it finds a relationship type that is not supported by the SyMS persistence layer. |
ErrPersistSymsStorageSourceTraitError | SDK logs this error when is.storagesource trait was missing from manifest. This trait is mandatory trait for writing into SyMS. To avoid this error please add this trait in manifest. |
ErrPersistSymsTableFormatTypeNotSupported | SDK logs this error when it encounters format type other than CSV and Parquet from SyMS. |
ErrPersistSymsTableInvalidDataLocation | SDK logs this error when it finds invalid or null data partitions or patterns in SyMS. |
ErrPersistSymsEntityDeclConversionFailure | SDK logs this error when it finds that storage descriptor received from SyMS has empty source location. |
ErrPersistSymsUnknownDataFormat | SDK logs this error when it couldn't find CDM-SyMS data format mapping for a data type. |
ErrPersistSymsUnsupportedTableFormat | SDK logs this error when it encounters format type other than CSV and Parquet from SyMS. |
ErrPersistSymsUnsupportedCdmConversion | SDK supports *.manifest.cdm.json or *.cdm.json file for SyMS. |
ErrPersistSymsUnsupportedManifest | SDK does not support saving databases.manifest.cdm.json file as it can cause perfomance issue on SyMS workspace. |
ErrPersistSaveLinkedDocs | SDK logs this error when it fails to save one or more linked (imported) documents. There may be variety of reasons, including imports with wrong paths to documents, absence of files or access limitations on the target location. Please inspect prior error messages to find possible root cause. |
ErrPersistUnsupportedJsonSemVer | SDK reports this error during loading of a document, when it realizes its jsonSchemaSemanticVersion is higher than what this SDK accepts. Upgrading to a newer version of the SDK is strongly advised. This ObjectModel version supports json semantic version {0} at maximum. |
ErrPersistPartitionLocMissing | This error is logged when SDK encounters a partition that does not have a location set. Please ensure the location property is set in each partition. |
ErrProjFailedToResolve | SDK logs this error when for any reason the projection context is not created correctly. It is a generic error that should be preceded by other error logs containing specific information about the kind of issue that lead to the projection context to be null. Failed to resolve a projection. Check previous logs to get more details. |
ErrProjInvalidAttrState | SDK logs this error occurs if a resolved attribute is null or if its name is null or an empty string. |
ErrProjRefAttrStateFailure | SDK logs this error when an attribute that is referenced by any operation within a projection can't be found. Verify that the source entity or the prior operations introduce an attribute with the specified name. |
ErrProjRenameFormatIsNotSet | SDK logs this error if the "renameFormat" property of an renameAttributes operation isn't set. Check the documentation for the operation here. |
ErrProjSourceError | SDK logs this error if the source of a projection that is applied to a data typed attribute is anything other than another projection. If you want the source to point to another entity use an entity typed attribute instead. |
ErrProjStringError | SDK logs this error if either the minimum or maximum cardinality isn't a valid number. |
ErrProjUnsupportedAttrGroups | This error is logged if an array expansion operation is applied to an attribute group. |
ErrProjUnsupportedSource | This error is logged if an projection operation is applied to an unexpected source. |
ErrRelMaxResolvedAttrReached | SDK logs this error during entity resolution process when the number of resolved attributes in an entity crosses the maximum number set in ResolveOptions.ResolvedAttributeLimit. Default limit is 4000, which is sufficient for general use. Before increasing this number, ensure you are aware of performance implications of allowing such large entities to be produced out of resolution process. |
ErrResolutionFailure | This error is logged when the data type of an argument of a trait reference does not match the expected data type specified on the trait definition. |
ErrResolveEntityFailure | This error is logged during resolution of a manifest when it is unable to fetch linked entity to perform its resolution. It may occur for variety of reasons, such as ErrPathNullObjectPath, ErrStorageNamespaceMismatch, ErrStorageInvalidPathFormat, ErrValdnInvalidDoc or ErrDocSymbolNotFound. Please inspect prior error messages to find possible root cause. |
ErrResolveFolderNotFound | SDK logs this error when it is not able to find folder to place the resolved entity in. There may be variety of reasons, including absence of folders, network problems and other. |
ErrResolveManifestFailed | This error is logged when the manifest for which resolution was requested has not been placed in a folder yet. Before calling CreateResolvedManifestAsync API, add the manifest to a CdmFolderDefinition representing the folder where this manifest should reside. |
ErrResolveNewEntityNameNotSet | SDK logs this error when new entity name has not been provided to CreateResolvedEntityAsync call. |
ErrResolveReferenceFailure | This error is logged during indexing of a document, when an object reference cannot be resolved to any known objects, and the ResolveOptions.ShallowValidation is set to False. Usual causes of this error are missing import of the document containing the object definition or misspelled object name. |
ErrStorageAdapterNotFound | The SDK attempted to obtain adapter associated with namespace that the given corpus path is part of, but could not find it. This error is usually reported after errors ErrStorageNullNamespace and ErrStorageAdapterNotFound. |
ErrStorageCdmStandardsMissing | The SDK was unable to find the CdmStandards package. Make sure that the SDK dependencies are properly installed. |
ErrStorageFolderNotFound | SDK logs this error when there is no folder exist from the given nampespace. |
ErrStorageInvalidPathFormat | SDK raises this error when the path does not start with '.' or contains '..' or '.'. |
ErrStorageMissingJsonConfig | This error is logged during mounting of adapters using provided configuration file, when adapter configuration property could not be found. This configuration file is invalid and needs to be corrected. |
ErrStorageMissingNamespace | This error is logged during mounting of adapters using provided configuration file, when adapter namespace property could not be found. This configuration file is invalid and needs to be corrected. |
ErrStorageMissingTypeJsonConfig | This error is logged during mounting of adapters using provided configuration file, when adapter type property could not be found. This configuration file is invalid and needs to be corrected. |
ErrStorageNamespaceMismatch | This error is logged when creating absolute corpus path using provided relative path and object, but the relative path and the provided object have different namespaces. Make sure path and object are located under the same namespace. |
ErrStorageNamespaceNotRegistered | SDK reports this error when provided corpus path has a namespace that has not been registered, meaning no adapter has been mounted to the specific namespace. Make sure that all namespaces have applicable adapters registered before loading documents or converting corpus paths. |
ErrStorageNullAdapter | SDK attempted to use adapter object but it was passed as null. Verify that the adapter object being mounted has been properly initialized. |
ErrStorageNullAdapterConfig | SDK logs this error when provided configuration from which adapters will be created is null. Verify that the adapter configuration string has been read properly from the file-system. |
ErrStorageNullCorpusPath | SDK logs this error when trying to parse corpus path either from an object or as supplied through public API, but the path is null. Make sure the objects have their corpus paths and that nulls are not passed as path arguments to the SDK's APIs. |
ErrStorageNullNamespace | This error is logged when namespace supplied to APIs to mount or unmount a namespace, or set or get registered adapter, or get namespace's root folder is null. Make sure to provide a correct namespace value to the SDK's APIs. |
ErrStorageObjectNodeCastFailed | SDK logs this error when the loaded config structure can't be mapped to objectNode. Usual root cause for this will be corruption of the config file. Check the exception message for more details. |
ErrSymbolNotFound | SDK logs this error when a symbol is being looked up but the document used as a point of reference has not been indexed and the ResolveOptions.ImportLoadStrategy is set to "DoNotLoad". Change the import load strategy to "Load" or "LazyLoad" to allow SDK to load and find the symbols. |
ErrTraitArgumentMissing | This error is logged during resolution, when SDK encounters a trait reference, which doesn't have arguments supplied for all of the required parameters defined in the trait definition. Check the trait definition and add missing arguments to the trait reference. |
ErrTraitAttrFetchError | SDK logs this error if it is unable to obtain attribute and its traits due to an unexpected exception. Check the exception for the root cause of the error. |
ErrTraitInvalidArgumentValueType | SDK logs this error if it encounters invalid argument value supplied for the parameter of the trait. |
ErrTraitResolutionFailure | SDK logs this error if it is unable to resolve trait arguments due to an unexpected exception. Check the exception for the root cause of the error. |
ErrUnexpectedDataType | SDK logs this error when it encounters unexpected data type or zero type. Expected data types are entity, attribute, dataType, purpose, trait, and attributeGroup. |
ErrUnexpectedIncrementalPartitionTrait | SDK logs this error when it encounters unexpected data type or zero type. Expected data types are entity, attribute, dataType, purpose, trait, and attributeGroup. |
ErrUnexpectedType | This error is logged when SDK finds symbol matching the given reference, but the type of the symbol isn't matching the type of the reference. This can happen, for example, if a data type reference name is actually belonging to a purpose definition. Correct the reference object to point at the right matching definition. |
ErrUnrecognizedDataType | This error is logged when SDK checks trait parameters and finds an unrecognized data type. Usual causes of this error are missing import of the document containing the data type definition or misspelled data type name. |
ErrUnsupportedRef | This error is logged when SDK finds a symbol reference that appears to be absolute, starting with '/'. Correct the reference to start with a moniker name. |
ErrUnsupportedType | This error is logged when "defaultValue" property of an attribute isn't a JSON array. Check the property and change its type accordingly. |
ErrValdnIntegrityCheckFailure | SDK logs this error when performing validation of the model and encounters objects that are not properly set. Check the message to find which information needs to be supplied for the specific object. Integrity check failed. The object '{0}' is missing the following fields: {1} |
ErrValdnInvalidCorpusPath | SDK logs this error when corpus path in a document isn't valid. This can usually occur after errors ErrPathNullObjectPath, ErrStorageInvalidPathFormat, or ErrStorageNamespaceMismatch. |
ErrValdnInvalidDoc | This error is logged when retrieving a document from the given path, but the document failed validation during the indexing process. Check prior errors logged by the SDK for potential root causes. |
ErrValdnInvalidExpression | This error is logged during parsing of a regular expression or glob pattern supplied in a Data Partition Pattern. Check the exception message for possible root cause. |
ErrValdnInvalidMaxCardinality | SDK logs this error when it tries to create entity attribute object but fails because of invalid maximum cardinality value. Ensure the value must is a number greater than zero or "*". |
ErrValdnInvalidMinCardinality | SDK logs this error when it tries to create entity attribute object but fails because of invalid minimum cardinality value. Ensure the value is greater than or equal to 0 and less than maximum cardinality. |
ErrValdnMissingDoc | Reported during indexing process when SDK encounters a document that has not been placed in any folder. To correct this, ensure all document definitions objects have been added to appropriate folder definition objects before indexing triggers. |
ErrValdnMissingLanguageTag | This error is logged when a defaultValue property doesn't have any entries in the array, or an entry is missing "languageTag" and "displayText" values. |
Warnings
Enum | Description |
---|---|
WarnAnnotationTypeNotSupported | SDK logs this warning when loading model.json file, when argument type provided in trait "is.modelConversion.otherAnnotations" is neither JObject nor a pair of "name" and "value" properties. Correct the argument accordingly to correct this warning. |
WarnDocChangesDiscarded | SDK logs this warning if a document had unsaved changes in it, but a request to reload this document was received. Any changes to the document will in this situation be discarded. Make sure to save updated documents before loading them again. |
WarnDocImportNotLoaded | This warning is logged when an import was not resolved to any document. This may be due to variety of reasons, such as import having wrong path, document missing in the file-system, access permissions, and others. Check the prior logs for potential root causes. |
WarnMaxDepthExceeded | This warning is logged when the max depth value is reached during resolution. The 'depth' is tracked as the number of nested entity attributes that are visited and resolved. If the max depth is reached, the entity attribute at this depth level will not be resolved, this warning will be logged, and resolution will continue after that entity attribute object. |
WarnLinkEntIdentArgsNotSupported | This warning is logged during resolution, if trait "is.linkedEntity.identifier" doesn't accept any arguments. This trait is used to record foreign key (linked entity) information. When this situation occurs, SDK will skip recording of the relationship information for the resolved foreign key attribute. Check definition of the trait to ensure it is properly structured and accepting relationship information arguments. |
WarnPartitionFileFetchFailed | This warning is logged while performing lookup of partitions on the target file-system, when an unexpected exception prevents from retrieving complete list of partitions and their details. The exception message will contain additional details about the root cause. Make sure the partition root location and pattern are correctly set and that the appropriate access level is available for accessing the partition files. |
WarnPartitionGlobAndRegexPresent | This warning is logged if a Data Partition Pattern has both regular expression and glob pattern properties set. In this situation glob pattern is used and regular expression ignored. |
WarnPartitionInvalidArguments | SDK logs this warning during creation of Data Partition Definition object from a document, when the argument attached to the partition in the document is malformed, for example if "key" or "value" properties are missing. Check the document and correct the partition object arguments. |
WarnPersistCustomExtNotSupported | This warning is logged if SDK encounters a referenced entity in a document with custom extension traits attached. This isn't supported and all such traits should be removed from the mentioned referenced entity. |
WarnPersistEntityMissing | This warning is logged if an entity in the model doesn't have an owner set, or the owner is set but it isn't of Document type. Make sure to all entity definitions are added to document objects. |
WarnPersistEnumNotFound | This warning is logged while loading type attribute from the document, when the "dataFormat" property is set to a non-recognizable value. Correct the value to be one of the values supported by the CdmDataFormat enumeration here |
WarnPersistFileModTimeFailure | This warning is logged during computation of last modified time of a document currently being loaded when SDK encounters an exception. Check the exception message for possible root cause. |
WarnPersistFileReadFailure | SDK logs this warning when attempting to load a document from a file-system via corresponding adapter, but encounters an exception. This is usually I/O related and possible root cause may be found in the exception details. |
WarnPersistJsonSemVerInvalidFormat | SDK logs this warning when "jsonSchemaSemanticVersion" property of a document has invalid format. Correct format is "{major}.{minor}.{patch}". |
WarnPersistJsonSemVerMandatory | This warning is logged when SDK loads a document and does not find "jsonSchemaSemanticVersion" property set in it. In this case, SDK will still attempt to load the document, but if there are unsupported features encountered that the parser cannot deal with, errors will get reported. |
WarnPersistModelJsonRelReadFailed | SDK logs this warning when loading relationships from model.json file, when one of the relationships is not properly defined. This warning is usually reported after warnings WarnPersistRelUndefinedSourceEntity and WarnPersistRelUndefinedTargetEntity. Please check the model.json's relationships list and correct entries that are missing the specific properties. |
WarnPersistPartitionNameNull | SDK logs this warning when saving manifest to model.json format, but finds a partition object that doesn't have name property set. Partition names are mandatory in model.json format, so the SDK will in this situation use empty string as the name. |
WarnPersistRelUndefinedSourceEntity | SDK logs this warning when loading relationships from model.json file, when one of the relationships is missing source entity name. Check the model.json's relationships list and correct entries that are missing this property. |
WarnPersistRelUndefinedTargetEntity | SDK logs this warning when loading relationships from model.json file, when one of the relationships is missing target entity name. Check the model.json's relationships list and correct entries that are missing this property. |
WarnPersistSymsEntityMissing | SDK logs this warning if entity is missing. |
WarnPersistSymsEntitySkipped | SDK logs this warning when it skips entity creation. This could occur if file format type isn't csv or storage descriptor received from SyMS doesn't have location. |
WarnPersistSymsProjNotExist | SDK logs this warning when it finds projection in document. CDM-SyMS works on resolve model. |
WarnPersistUnsupportedJsonSemVer | SDK reports this warning during loading of a document, when it realizes its jsonSchemaSemanticVersion is higher than what this SDK accepts. Upgrading to a newer version of the SDK is advised. |
WarnProjRenameAttrNotSupported | SDK logs this warning when it tries to rename an attribute group, but this action is currently not supported. Avoid running rename operation over attribute groups. |
WarnProjAddArtifactAttrNotSupported | SDK logs this warning when it tries to add an artifact attribute to an entity attribute or an attribute group, but this action is currently not supported. Avoid running add artifact attribute operation over entity attributes or attribute groups. |
WarnResolveAttrFailed | The Object Model supports a path that is a promise to a resolved attribute. The path follows the format {entityName}/(resolvedAttributes)/{attributeName}. This warning is logged if the OM can find the entity but within its attributes it can't find the "attributeName" provided. |
WarnResolveEntityFailed | SDK logs this warning when it fails to resolve entity from the given reference. |
WarnResolveImportFailed | SDL logs this warning when import resolution fails. There may be variety of reasons causing this issue, such as wrong import paths, missing documents on the target file-system, access permissions and others. Check prior logged messages for possible root cause. |
WarnResolveObjectFailed | This warning is logged when SDK fails to find object by the name given in the reference. Usual causes of this are missing import of the document containing the object definition or misspelled object name. |
WarnResolveReferenceFailure | This warning is logged during indexing of a document, when an object reference cannot be resolved to any known objects, and the ResolveOptions.ShallowValidation is set to True. Usual causes of this error are missing import of the document containing the object definition or misspelled object name. |
WarnStorageInvalidAdapterPath | This warning is reported when SDK attempts to convert given corpus path to an adapter path, but there was no adapter found that understood this corpus path. Make sure that all adapters the given schema relies on are mounted on the corpus object before loading the schema. |
WarnStorageExpectedPathPrefix | This warning is logged if a folder path of an object does not end with '/'. SDK will auto-correct this by appending the '/' symbol to the folder path. |
WarnStorageRemoveAdapterFailed | SDK logs this warning when unmounting of a non-existent namespace has been requested. Make sure a valid namespace value has been provided to the API. |
WarnValdnEntityNotDefined | SDK logs this warning when it encounters a Constant entity without a constant value. Make sure to supply constant values after defining a Constant entity object. |
WarnValdnMaxOrdinalTooHigh | This warning is logged if the "EndOrdinal" property of an array expansion operation is bigger than the maximum allowed ordinal provided in the ResolveOptions.MaxOrdinalForArrayExpansion property. |
WarnValdnPrimaryKeyMissing | SDK logs this warning when a resolved entity doesn't have an "is.identifiedBy" trait, which means that there was no primary key defined in the entity. Usually this isn't a valid scenario, and introducing a primary key in the specified entity is a proper corrective action. |
WarnDeprecatedResolutionGuidance | SDK logs this warning is logged on CreateResolvedEntityAsync if resolution guidance is used anywhere on the logical entity. |
WarnProjAddArtifactAttrNotSupported | SDK logs this warning if the attribute supplied to the AddArtifactAttribute operation isn't a Data Type Attribute. |
WarnProjCreateForeignKeyTraits | SDK logs this warning to indicate an internal error where an attribute doesn't have the owner property set. |
WarnProjFKWithoutSourceEntity | This warning is logged if a replaceAsForeignKey operation is used while extending an entity or on an data typed attribute. This operation is only allowed on an entity typed attribute. |
WarnTelemetryIngestionFailed | This warning is logged when the Kusto ingestion process throws an exception due to authentication failure or HTTP request failure. |
WarnTelemetryMaxQueueSizeReached | This warning is logged when the Kusto ingestion fails because ingestion queue reaches its maximum size. |
WarnValdnOrdinalStartEndOrder | This warning is logged if the "StartOrdinal" of an array expansion operation is smaller than the "EndOrdinal". In that case the operation won't execute. |
WarnUnmountCdmNamespace | This warning is logged if the user manually unmounts the 'cdm' namespace. Now that the CDM schema store has been deprecated, unmounting the 'cdm' namespace is unnecessary and may cause schemas to not be loaded properly. |