acryl-datahub 1.1.1rc4__py3-none-any.whl → 1.3.0.1rc9__py3-none-any.whl

datahub/metadata/schemas/RelationshipChangeEvent.avsc

@@ -0,0 +1,215 @@
+{
+  "type": "record",
+  "Event": {
+    "name": "relationshipChangeEvent"
+  },
+  "name": "RelationshipChangeEvent",
+  "namespace": "com.linkedin.pegasus2avro.platform.event.v1",
+  "fields": [
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "KafkaAuditHeader",
+          "namespace": "com.linkedin.events",
+          "fields": [
+            {
+              "compliance": [
+                {
+                  "policy": "EVENT_TIME"
+                }
+              ],
+              "type": "long",
+              "name": "time",
+              "doc": "The time at which the event was emitted into kafka."
+            },
+            {
+              "compliance": "NONE",
+              "type": "string",
+              "name": "server",
+              "doc": "The fully qualified name of the host from which the event is being emitted."
+            },
+            {
+              "compliance": "NONE",
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "instance",
+              "default": null,
+              "doc": "The instance on the server from which the event is being emitted. e.g. i001"
+            },
+            {
+              "compliance": "NONE",
+              "type": "string",
+              "name": "appName",
+              "doc": "The name of the application from which the event is being emitted. see go/appname"
+            },
+            {
+              "compliance": "NONE",
+              "type": {
+                "type": "fixed",
+                "name": "UUID",
+                "namespace": "com.linkedin.events",
+                "size": 16
+              },
+              "name": "messageId",
+              "doc": "A unique identifier for the message"
+            },
+            {
+              "compliance": "NONE",
+              "type": [
+                "null",
+                "int"
+              ],
+              "name": "auditVersion",
+              "default": null,
+              "doc": "The version that is being used for auditing. In version 0, the audit trail buckets events into 10 minute audit windows based on the EventHeader timestamp. In version 1, the audit trail buckets events as follows: if the schema has an outer KafkaAuditHeader, use the outer audit header timestamp for bucketing; else if the EventHeader has an inner KafkaAuditHeader use that inner audit header's timestamp for bucketing"
+            },
+            {
+              "compliance": "NONE",
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "fabricUrn",
+              "default": null,
+              "doc": "The fabricUrn of the host from which the event is being emitted. Fabric Urn in the format of urn:li:fabric:{fabric_name}. See go/fabric."
+            },
+            {
+              "compliance": "NONE",
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "clusterConnectionString",
+              "default": null,
+              "doc": "This is a String that the client uses to establish some kind of connection with the Kafka cluster. The exact format of it depends on specific versions of clients and brokers. This information could potentially identify the fabric and cluster with which the client is producing to or consuming from."
+            }
+          ],
+          "doc": "This header records information about the context of an event as it is emitted into kafka and is intended to be used by the kafka audit application.  For more information see go/kafkaauditheader"
+        }
+      ],
+      "name": "auditHeader",
+      "default": null,
+      "doc": "Kafka audit header containing metadata about the message itself.\nIncludes information like message ID, timestamp, and server details."
+    },
+    {
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": "string",
+      "name": "sourceUrn",
+      "doc": "The URN (Uniform Resource Name) of the source entity in the relationship.\nIn a downstream relationship example, this would be the URN of the upstream dataset.",
+      "Urn": "Urn"
+    },
+    {
+      "java": {
+        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+      },
+      "type": "string",
+      "name": "destinationUrn",
+      "doc": "The URN of the destination entity in the relationship.\nIn a downstream relationship example, this would be the URN of the downstream dataset.",
+      "Urn": "Urn"
+    },
+    {
+      "type": {
+        "type": "enum",
+        "name": "RelationshipChangeOperation",
+        "namespace": "com.linkedin.pegasus2avro.platform.event.v1",
+        "symbols": [
+          "ADD",
+          "REMOVE",
+          "RESTATE"
+        ]
+      },
+      "name": "operation",
+      "doc": "The operation being performed on this relationship.\nTypically includes operations like ADD, REMOVE, or RESTATE."
+    },
+    {
+      "type": "string",
+      "name": "relationshipType",
+      "doc": "The type/category of relationship being established or modified.\nExamples: \"DownstreamOf\", \"Contains\", \"OwnedBy\", \"DerivedFrom\", etc."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "lifecycleOwner",
+      "default": null,
+      "doc": "The system or service responsible for managing the lifecycle of this relationship.\nThis helps identify which component has authority over the relationship."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "via",
+      "default": null,
+      "doc": "Information about how or through what means this relationship was established.\nCould indicate a specific pipeline, process, or tool that discovered/created the relationship."
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "map",
+          "values": "string"
+        }
+      ],
+      "name": "properties",
+      "default": null,
+      "doc": "Additional custom properties associated with this relationship.\nAllows for flexible extension without changing the schema."
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "AuditStamp",
+        "namespace": "com.linkedin.pegasus2avro.common",
+        "fields": [
+          {
+            "type": "long",
+            "name": "time",
+            "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."
+          },
+          {
+            "java": {
+              "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+            },
+            "type": "string",
+            "name": "actor",
+            "doc": "The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change.",
+            "Urn": "Urn"
+          },
+          {
+            "java": {
+              "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+            },
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "impersonator",
+            "default": null,
+            "doc": "The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor.",
+            "Urn": "Urn"
+          },
+          {
+            "type": [
+              "null",
+              "string"
+            ],
+            "name": "message",
+            "default": null,
+            "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."
+          }
+        ],
+        "doc": "Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage."
+      },
+      "name": "auditStamp",
+      "doc": "Stores information about who made this change and when.\nContains the actor (user or system) that performed the action and the timestamp."
+    }
+  ],
+  "doc": "Kafka event for proposing a relationship change between two entities.\nFor example, when dataset1 establishes a new downstream relationship with dataset2."
+}

datahub/metadata/schemas/SchemaFieldKey.avsc

@@ -14,7 +14,10 @@
       "documentation",
       "testResults",
       "deprecation",
-      "subTypes"
+      "subTypes",
+      "logicalParent",
+      "globalTags",
+      "glossaryTerms"
     ]
   },
   "name": "SchemaFieldKey",

datahub/metadata/schemas/StructuredProperties.avsc

@@ -94,6 +94,75 @@
               "name": "lastModified",
               "default": null,
               "doc": "Audit stamp containing who last modified this relationship edge and when"
+            },
+            {
+              "Searchable": {
+                "/actor": {
+                  "fieldName": "structuredPropertyAttributionActors",
+                  "fieldType": "URN",
+                  "queryByDefault": false
+                },
+                "/source": {
+                  "fieldName": "structuredPropertyAttributionSources",
+                  "fieldType": "URN",
+                  "queryByDefault": false
+                },
+                "/time": {
+                  "fieldName": "structuredPropertyAttributionDates",
+                  "fieldType": "DATETIME",
+                  "queryByDefault": false
+                }
+              },
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "MetadataAttribution",
+                  "namespace": "com.linkedin.pegasus2avro.common",
+                  "fields": [
+                    {
+                      "type": "long",
+                      "name": "time",
+                      "doc": "When this metadata was updated."
+                    },
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "type": "string",
+                      "name": "actor",
+                      "doc": "The entity (e.g. a member URN) responsible for applying the assocated metadata. This can\neither be a user (in case of UI edits) or the datahub system for automation.",
+                      "Urn": "Urn"
+                    },
+                    {
+                      "java": {
+                        "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                      },
+                      "type": [
+                        "null",
+                        "string"
+                      ],
+                      "name": "source",
+                      "default": null,
+                      "doc": "The DataHub source responsible for applying the associated metadata. This will only be filled out\nwhen a DataHub source is responsible. This includes the specific metadata test urn, the automation urn.",
+                      "Urn": "Urn"
+                    },
+                    {
+                      "type": {
+                        "type": "map",
+                        "values": "string"
+                      },
+                      "name": "sourceDetail",
+                      "default": {},
+                      "doc": "The details associated with why this metadata was applied. For example, this could include\nthe actual regex rule, sql statement, ingestion pipeline ID, etc."
+                    }
+                  ],
+                  "doc": "Information about who, why, and how this metadata was applied"
+                }
+              ],
+              "name": "attribution",
+              "default": null,
+              "doc": "Information about who, why, and how this metadata was applied"
             }
           ]
         }

datahub/metadata/schemas/StructuredPropertySettings.avsc

@@ -33,6 +33,15 @@
       "default": false,
       "doc": "Whether or not this asset should be displayed in the asset sidebar"
     },
+    {
+      "Searchable": {
+        "fieldType": "BOOLEAN"
+      },
+      "type": "boolean",
+      "name": "hideInAssetSummaryWhenEmpty",
+      "default": false,
+      "doc": "Whether or not this asset should be hidden in the asset sidebar (showInAssetSummary should be enabled)\nwhen its value is empty"
+    },
     {
       "Searchable": {
         "fieldType": "BOOLEAN"

datahub/metadata/schemas/SystemMetadata.avsc

@@ -80,6 +80,67 @@
       "name": "version",
       "default": null,
       "doc": "Aspect version\n   Initial implementation will use the aspect version's number, however stored as\n   a string in the case where a different aspect versioning scheme is later adopted."
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "AuditStamp",
+          "namespace": "com.linkedin.pegasus2avro.common",
+          "fields": [
+            {
+              "type": "long",
+              "name": "time",
+              "doc": "When did the resource/association/sub-resource move into the specific lifecycle stage represented by this AuditEvent."
+            },
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": "string",
+              "name": "actor",
+              "doc": "The entity (e.g. a member URN) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change.",
+              "Urn": "Urn"
+            },
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "impersonator",
+              "default": null,
+              "doc": "The entity (e.g. a service URN) which performs the change on behalf of the Actor and must be authorized to act as the Actor.",
+              "Urn": "Urn"
+            },
+            {
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "message",
+              "default": null,
+              "doc": "Additional context around how DataHub was informed of the particular change. For example: was the change created by an automated process, or manually."
+            }
+          ],
+          "doc": "Data captured on a resource/association/sub-resource level giving insight into when that resource/association/sub-resource moved into a particular lifecycle stage, and who acted to move it into that specific lifecycle stage."
+        }
+      ],
+      "name": "aspectCreated",
+      "default": null,
+      "doc": "When the aspect was initially created and who created it, detected by version 0 -> 1 change"
+    },
+    {
+      "type": [
+        "null",
+        "com.linkedin.pegasus2avro.common.AuditStamp"
+      ],
+      "name": "aspectModified",
+      "default": null,
+      "doc": "When the aspect was last modified and the actor that performed the modification"
     }
   ],
   "doc": "Metadata associated with each metadata change that is processed by the system"

datahub/metadata/schemas/UpstreamLineage.avsc

@@ -94,6 +94,7 @@
               "Searchable": {
                 "fieldName": "upstreams",
                 "fieldType": "URN",
+                "hasValuesFieldName": "hasUpstreams",
                 "queryByDefault": false
               },
               "java": {
@@ -199,6 +200,14 @@
                 "doc": "The type of upstream entity"
               },
               {
+                "Searchable": {
+                  "/*": {
+                    "fieldName": "fineGrainedUpstreams",
+                    "fieldType": "URN",
+                    "hasValuesFieldName": "hasFineGrainedUpstreams",
+                    "queryByDefault": false
+                  }
+                },
                 "type": [
                   "null",
                   {

datahub/sdk/__init__.py

@@ -18,7 +18,9 @@ from datahub.metadata.urns import (
     SchemaFieldUrn,
     TagUrn,
 )
+from datahub.sdk.chart import Chart
 from datahub.sdk.container import Container
+from datahub.sdk.dashboard import Dashboard
 from datahub.sdk.dataflow import DataFlow
 from datahub.sdk.datajob import DataJob
 from datahub.sdk.dataset import Dataset

datahub/sdk/_all_entities.py

@@ -1,6 +1,8 @@
 from typing import Dict, List, Type
 
+from datahub.sdk.chart import Chart
 from datahub.sdk.container import Container
+from datahub.sdk.dashboard import Dashboard
 from datahub.sdk.dataflow import DataFlow
 from datahub.sdk.datajob import DataJob
 from datahub.sdk.dataset import Dataset
@@ -8,6 +10,8 @@ from datahub.sdk.entity import Entity
 from datahub.sdk.mlmodel import MLModel
 from datahub.sdk.mlmodelgroup import MLModelGroup
 
+# Base entity classes that don't have circular dependencies
+# Those that do are imported in the EntityClient where needed
 # TODO: Is there a better way to declare this?
 ENTITY_CLASSES_LIST: List[Type[Entity]] = [
     Container,
@@ -16,8 +20,11 @@ ENTITY_CLASSES_LIST: List[Type[Entity]] = [
     MLModelGroup,
     DataFlow,
     DataJob,
+    Dashboard,
+    Chart,
 ]
 
+# Create the mapping of entity types to classes
 ENTITY_CLASSES: Dict[str, Type[Entity]] = {
     cls.get_urn_type().ENTITY_TYPE: cls for cls in ENTITY_CLASSES_LIST
 }