acryl-datahub 1.0.0rc18__py3-none-any.whl → 1.3.0.1rc9__py3-none-any.whl

datahub/metadata/schemas/DataHubPageTemplateProperties.avsc

@@ -0,0 +1,251 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubPageTemplateProperties"
+  },
+  "name": "DataHubPageTemplateProperties",
+  "namespace": "com.linkedin.pegasus2avro.template",
+  "fields": [
+    {
+      "Relationship": {
+        "/*/modules/*": {
+          "entityTypes": [
+            "dataHubPageModule"
+          ],
+          "name": "ContainedIn"
+        }
+      },
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "DataHubPageTemplateRow",
+          "namespace": "com.linkedin.pegasus2avro.template",
+          "fields": [
+            {
+              "type": {
+                "type": "array",
+                "items": "string"
+              },
+              "name": "modules",
+              "doc": "The modules that exist in this template row",
+              "Urn": "Urn",
+              "urn_is_array": true
+            }
+          ],
+          "doc": "A row of modules contained in a template"
+        }
+      },
+      "name": "rows",
+      "doc": "The rows of modules contained in this template"
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "DataHubPageTemplateAssetSummary",
+          "namespace": "com.linkedin.pegasus2avro.template",
+          "fields": [
+            {
+              "type": [
+                "null",
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "record",
+                    "name": "SummaryElement",
+                    "namespace": "com.linkedin.pegasus2avro.template",
+                    "fields": [
+                      {
+                        "type": {
+                          "type": "enum",
+                          "name": "SummaryElementType",
+                          "namespace": "com.linkedin.pegasus2avro.template",
+                          "symbols": [
+                            "CREATED",
+                            "TAGS",
+                            "GLOSSARY_TERMS",
+                            "OWNERS",
+                            "DOMAIN",
+                            "STRUCTURED_PROPERTY"
+                          ]
+                        },
+                        "name": "elementType",
+                        "doc": "The type of element/property"
+                      },
+                      {
+                        "Relationship": {
+                          "entityTypes": [
+                            "structuredProperty"
+                          ],
+                          "name": "ContainsStructuredProperty"
+                        },
+                        "java": {
+                          "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                        },
+                        "type": [
+                          "null",
+                          "string"
+                        ],
+                        "name": "structuredPropertyUrn",
+                        "default": null,
+                        "doc": "The urn of the structured property shown. Required if propertyType is STRUCTURED_PROPERTY",
+                        "Urn": "Urn",
+                        "entityTypes": [
+                          "structuredProperty"
+                        ]
+                      }
+                    ],
+                    "doc": "Info for a given asset summary element"
+                  }
+                }
+              ],
+              "name": "summaryElements",
+              "default": null,
+              "doc": "The optional list of properties shown on an asset summary page header."
+            }
+          ],
+          "doc": "The page template info for asset summaries"
+        }
+      ],
+      "name": "assetSummary",
+      "default": null,
+      "doc": "The optional info for asset summaries. Should be populated if surfaceType is ASSET_SUMMARY"
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "DataHubPageTemplateSurface",
+        "namespace": "com.linkedin.pegasus2avro.template",
+        "fields": [
+          {
+            "Searchable": {
+              "fieldType": "KEYWORD"
+            },
+            "type": {
+              "type": "enum",
+              "symbolDocs": {
+                "ASSET_SUMMARY": "This template applies to what to display on asset summary pages",
+                "HOME_PAGE": "This template applies to what to display on the home page for users."
+              },
+              "name": "PageTemplateSurfaceType",
+              "namespace": "com.linkedin.pegasus2avro.template",
+              "symbols": [
+                "HOME_PAGE",
+                "ASSET_SUMMARY"
+              ]
+            },
+            "name": "surfaceType",
+            "doc": "Where exactly is this template being used"
+          }
+        ],
+        "doc": "Info about the surface area of the product that this template is deployed in"
+      },
+      "name": "surface",
+      "doc": "Info about the surface area of the product that this template is deployed in"
+    },
+    {
+      "type": {
+        "type": "record",
+        "name": "DataHubPageTemplateVisibility",
+        "namespace": "com.linkedin.pegasus2avro.template",
+        "fields": [
+          {
+            "Searchable": {
+              "fieldType": "KEYWORD"
+            },
+            "type": {
+              "type": "enum",
+              "symbolDocs": {
+                "GLOBAL": "This template is used across users",
+                "PERSONAL": "This template is used for individual use only"
+              },
+              "name": "PageTemplateScope",
+              "namespace": "com.linkedin.pegasus2avro.template",
+              "symbols": [
+                "PERSONAL",
+                "GLOBAL"
+              ]
+            },
+            "name": "scope",
+            "doc": "The scope of this template and who can use/see it"
+          }
+        ],
+        "doc": "Info about the visibility of this template"
+      },
+      "name": "visibility",
+      "doc": "Info about the visibility of this template"
+    },
+    {
+      "Searchable": {
+        "/actor": {
+          "fieldName": "createdBy",
+          "fieldType": "URN"
+        },
+        "/time": {
+          "fieldName": "createdAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "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": "created",
+      "doc": "Audit stamp for when and by whom this template was created"
+    },
+    {
+      "Searchable": {
+        "/time": {
+          "fieldName": "lastModifiedAt",
+          "fieldType": "DATETIME"
+        }
+      },
+      "type": "com.linkedin.pegasus2avro.common.AuditStamp",
+      "name": "lastModified",
+      "doc": "Audit stamp for when and by whom this template was last updated"
+    }
+  ],
+  "doc": "The main properties of a DataHub page template"
+}

datahub/metadata/schemas/DataHubPolicyInfo.avsc

@@ -110,13 +110,15 @@
                                 "type": "enum",
                                 "symbolDocs": {
                                   "EQUALS": "Whether the field matches the value",
+                                  "NOT_EQUALS": "Whether the field does not match the value",
                                   "STARTS_WITH": "Whether the field value starts with the value"
                                 },
                                 "name": "PolicyMatchCondition",
                                 "namespace": "com.linkedin.pegasus2avro.policy",
                                 "symbols": [
                                   "EQUALS",
-                                  "STARTS_WITH"
+                                  "STARTS_WITH",
+                                  "NOT_EQUALS"
                                 ],
                                 "doc": "The matching condition in a filter criterion"
                               },
@@ -138,6 +140,15 @@
               "name": "filter",
               "default": null,
               "doc": "Filter to apply privileges to"
+            },
+            {
+              "type": [
+                "null",
+                "com.linkedin.pegasus2avro.policy.PolicyMatchFilter"
+              ],
+              "name": "privilegeConstraints",
+              "default": null,
+              "doc": "Constraints around what sub-resources operations are allowed to modify, i.e. NOT_EQUALS - cannot modify a particular defined tag, EQUALS - can only modify a particular defined tag, STARTS_WITH - can only modify a tag starting with xyz"
             }
           ],
           "doc": "Information used to filter DataHub resource."

datahub/metadata/schemas/DataJobInfo.avsc

@@ -213,13 +213,17 @@
             "DEV": "Designates development fabrics",
             "EI": "Designates early-integration fabrics",
             "NON_PROD": "Designates non-production fabrics",
+            "PRD": "Alternative Prod spelling",
             "PRE": "Designates pre-production fabrics",
             "PROD": "Designates production fabrics",
             "QA": "Designates quality assurance fabrics",
             "RVW": "Designates review fabrics",
             "SANDBOX": "Designates sandbox fabrics",
+            "SBX": "Alternative spelling for sandbox",
+            "SIT": "System Integration Testing",
             "STG": "Designates staging fabrics",
             "TEST": "Designates testing fabrics",
+            "TST": "Alternative Test spelling",
             "UAT": "Designates user acceptance testing fabrics"
           },
           "name": "FabricType",
@@ -236,6 +240,10 @@
             "PROD",
             "CORP",
             "RVW",
+            "PRD",
+            "TST",
+            "SIT",
+            "SBX",
             "SANDBOX"
           ],
           "doc": "Fabric group type"

datahub/metadata/schemas/DataJobInputOutput.avsc

@@ -375,6 +375,14 @@
                 "doc": "The type of upstream entity"
               },
               {
+                "Searchable": {
+                  "/*": {
+                    "fieldName": "fineGrainedUpstreams",
+                    "fieldType": "URN",
+                    "hasValuesFieldName": "hasFineGrainedUpstreams",
+                    "queryByDefault": false
+                  }
+                },
                 "type": [
                   "null",
                   {

datahub/metadata/schemas/DataJobKey.avsc

@@ -8,6 +8,7 @@
       "datahubIngestionRunSummary",
       "datahubIngestionCheckpoint",
       "domains",
+      "applications",
       "deprecation",
       "versionInfo",
       "dataJobInfo",

datahub/metadata/schemas/DataProcessInstanceInput.avsc

@@ -41,7 +41,8 @@
           "createdOn": "inputEdges/*/created/time",
           "entityTypes": [
             "dataset",
-            "mlModel"
+            "mlModel",
+            "dataProcessInstance"
           ],
           "isLineage": true,
           "name": "DataProcessInstanceConsumes",

datahub/metadata/schemas/DataProcessInstanceOutput.avsc

@@ -41,7 +41,8 @@
           "createdOn": "outputEdges/*/created/time",
           "entityTypes": [
             "dataset",
-            "mlModel"
+            "mlModel",
+            "dataProcessInstance"
           ],
           "isLineage": true,
           "isUpstream": false,

datahub/metadata/schemas/DataProcessKey.avsc

@@ -46,13 +46,17 @@
           "DEV": "Designates development fabrics",
           "EI": "Designates early-integration fabrics",
           "NON_PROD": "Designates non-production fabrics",
+          "PRD": "Alternative Prod spelling",
           "PRE": "Designates pre-production fabrics",
           "PROD": "Designates production fabrics",
           "QA": "Designates quality assurance fabrics",
           "RVW": "Designates review fabrics",
           "SANDBOX": "Designates sandbox fabrics",
+          "SBX": "Alternative spelling for sandbox",
+          "SIT": "System Integration Testing",
           "STG": "Designates staging fabrics",
           "TEST": "Designates testing fabrics",
+          "TST": "Alternative Test spelling",
           "UAT": "Designates user acceptance testing fabrics"
         },
         "name": "FabricType",
@@ -69,6 +73,10 @@
           "PROD",
           "CORP",
           "RVW",
+          "PRD",
+          "TST",
+          "SIT",
+          "SBX",
           "SANDBOX"
         ],
         "doc": "Fabric group type"

datahub/metadata/schemas/DataProductKey.avsc

@@ -9,13 +9,15 @@
       "glossaryTerms",
       "globalTags",
       "domains",
+      "applications",
       "dataProductProperties",
       "institutionalMemory",
       "status",
       "structuredProperties",
       "forms",
       "testResults",
-      "subTypes"
+      "subTypes",
+      "assetSettings"
     ]
   },
   "name": "DataProductKey",

datahub/metadata/schemas/DataProductProperties.avsc

@@ -65,7 +65,7 @@
       ],
       "name": "description",
       "default": null,
-      "doc": "Documentation of the dataset"
+      "doc": "Documentation of the data product"
     },
     {
       "Relationship": {

datahub/metadata/schemas/DataTransformLogic.avsc

@@ -31,12 +31,14 @@
                       "type": {
                         "type": "enum",
                         "symbolDocs": {
-                          "SQL": "A SQL Query"
+                          "SQL": "A SQL Query",
+                          "UNKNOWN": "Unknown query language"
                         },
                         "name": "QueryLanguage",
                         "namespace": "com.linkedin.pegasus2avro.query",
                         "symbols": [
-                          "SQL"
+                          "SQL",
+                          "UNKNOWN"
                         ]
                       },
                       "name": "language",

datahub/metadata/schemas/DatasetKey.avsc

@@ -11,6 +11,7 @@
       "datasetUsageStatistics",
       "operation",
       "domains",
+      "applications",
       "schemaMetadata",
       "status",
       "container",
@@ -37,7 +38,8 @@
       "forms",
       "partitionsSummary",
       "versionProperties",
-      "icebergCatalogInfo"
+      "icebergCatalogInfo",
+      "logicalParent"
     ],
     "entityDoc": "Datasets represent logical or physical data assets stored or represented in various data platforms. Tables, Views, Streams are all instances of datasets."
   },
@@ -82,13 +84,17 @@
           "DEV": "Designates development fabrics",
           "EI": "Designates early-integration fabrics",
           "NON_PROD": "Designates non-production fabrics",
+          "PRD": "Alternative Prod spelling",
           "PRE": "Designates pre-production fabrics",
           "PROD": "Designates production fabrics",
           "QA": "Designates quality assurance fabrics",
           "RVW": "Designates review fabrics",
           "SANDBOX": "Designates sandbox fabrics",
+          "SBX": "Alternative spelling for sandbox",
+          "SIT": "System Integration Testing",
           "STG": "Designates staging fabrics",
           "TEST": "Designates testing fabrics",
+          "TST": "Alternative Test spelling",
           "UAT": "Designates user acceptance testing fabrics"
         },
         "name": "FabricType",
@@ -105,6 +111,10 @@
           "PROD",
           "CORP",
           "RVW",
+          "PRD",
+          "TST",
+          "SIT",
+          "SBX",
           "SANDBOX"
         ],
         "doc": "Fabric group type"

datahub/metadata/schemas/DatasetUsageStatistics.avsc

@@ -130,6 +130,10 @@
       "doc": "The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value."
     },
     {
+      "Searchable": {
+        "fieldType": "COUNT",
+        "hasValuesFieldName": "hasUniqueUserCount"
+      },
       "TimeseriesField": {},
       "type": [
         "null",
@@ -140,6 +144,10 @@
       "doc": "Unique user count"
     },
     {
+      "Searchable": {
+        "fieldType": "COUNT",
+        "hasValuesFieldName": "hasTotalSqlQueriesCount"
+      },
       "TimeseriesField": {},
       "type": [
         "null",

datahub/metadata/schemas/Deprecation.avsc

@@ -8,7 +8,9 @@
   "fields": [
     {
       "Searchable": {
+        "addToFilters": true,
         "fieldType": "BOOLEAN",
+        "filterNameOverride": "Deprecated",
         "weightsPerFieldValue": {
           "true": 0.5
         }

datahub/metadata/schemas/DomainKey.avsc

@@ -11,7 +11,8 @@
       "structuredProperties",
       "forms",
       "testResults",
-      "displayProperties"
+      "displayProperties",
+      "assetSettings"
     ],
     "entityDoc": "A data domain within an organization."
   },

datahub/metadata/schemas/ExecutionRequestInput.avsc

@@ -20,6 +20,11 @@
       "doc": "Arguments provided to the task"
     },
     {
+      "Searchable": {
+        "fieldName": "executorId",
+        "fieldType": "KEYWORD",
+        "queryByDefault": false
+      },
       "type": "string",
       "name": "executorId",
       "doc": "Advanced: specify a specific executor to route the request to. If none is provided, a \"default\" executor is used."

datahub/metadata/schemas/FormInfo.avsc

@@ -53,6 +53,11 @@
           "namespace": "com.linkedin.pegasus2avro.form",
           "fields": [
             {
+              "Searchable": {
+                "fieldName": "promptId",
+                "fieldType": "KEYWORD",
+                "queryByDefault": false
+              },
               "type": "string",
               "name": "id",
               "doc": "The unique id for this prompt. This must be GLOBALLY unique."