Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Invalidate

Invalidates all the properties stored for an entire document.
Read time 1 minuteLast updated 10 days ago

Definition

Invalidate(string)

Invalidates all the properties stored for an entire document.
public void Invalidate(string documentId)

Parameters

documentId

A document identifier.

Examples

// Store multiple properties of a document.var document = "path/to/my/asset";propertyDatabase.Store(document, "prop1", "value1");propertyDatabase.Store(document, "prop2", "value2");// Invalidate the entire document.propertyDatabase.Invalidate(document);// The invalidated document can no longer be retrieved.if (propertyDatabase.TryLoad(PropertyDatabase.CreateDocumentKey(document), out IEnumerable<object> documentValues)) Assert.Fail("TryLoad should have failed to retrieve the document values.");

Invalidate(ulong)

Invalidates all the properties stored for an entire document.
public void Invalidate(ulong documentKey)

Parameters

documentKey

A document key.

Remarks

// Store multiple properties of a document.var documentKey = PropertyDatabase.CreateDocumentKey("path/to/my/asset");propertyDatabase.Store(documentKey, PropertyDatabase.CreatePropertyHash("prop1"), "value1");propertyDatabase.Store(documentKey, PropertyDatabase.CreatePropertyHash("prop2"), "value2");// Invalidate the entire document by its key.propertyDatabase.Invalidate(documentKey);// The invalidated document can no longer be retrieved.if (propertyDatabase.TryLoad(documentKey, out IEnumerable<object> documentKeyValues)) Assert.Fail("TryLoad should have failed to retrieve the document values.");
Additional Resources: PropertyDatabase.CreateDocumentKey.

Invalidate(PropertyDatabaseRecordKey)

Invalidates a single property record so it is no longer retrievable.
public void Invalidate(in PropertyDatabaseRecordKey recordKey)

Parameters

A record key.

Remarks

// Store a property.var propertyRecordKey = PropertyDatabase.CreateRecordKey("path/to/my/asset", "m_Color");propertyDatabase.Store(propertyRecordKey, new Color(1, 0, 1));// Invalidate the property.propertyDatabase.Invalidate(propertyRecordKey);// The invalidated property can no longer be retrieved.if (propertyDatabase.TryLoad(propertyRecordKey, out object propertyValue)) Assert.Fail("TryLoad should have failed to retrieve the record.");
Additional Resources: PropertyDatabase.CreateRecordKey.