acryl-datahub-cloud 0.3.8rc7__py3-none-any.whl → 0.3.8rc9__py3-none-any.whl

acryl_datahub_cloud/metadata/schemas/QueryUsageFeatures.avsc

@@ -0,0 +1,94 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "queryUsageFeatures"
+  },
+  "name": "QueryUsageFeatures",
+  "namespace": "com.linkedin.pegasus2avro.query",
+  "fields": [
+    {
+      "Searchable": {
+        "fieldName": "queryCountLast30DaysFeature",
+        "fieldType": "COUNT"
+      },
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "queryCountLast30Days",
+      "default": null,
+      "doc": "Number of times this query was executed in the last 30 days"
+    },
+    {
+      "Searchable": {
+        "fieldName": "queryCountFeature",
+        "fieldType": "COUNT"
+      },
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "queryCountTotal",
+      "default": null,
+      "doc": "Query count total \nTotal number of executions of this query"
+    },
+    {
+      "Searchable": {
+        "/*": {
+          "fieldName": "topUsersLast30DaysFeature",
+          "fieldType": "URN",
+          "hasValuesFieldName": "hasTopUsersLast30DaysFeature"
+        }
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": "string"
+        }
+      ],
+      "name": "topUsersLast30Days",
+      "default": null,
+      "doc": "Top users of this query in the last 30 days",
+      "Urn": "Urn",
+      "urn_is_array": true
+    },
+    {
+      "Searchable": {
+        "fieldName": "queryCostLast30DaysFeature"
+      },
+      "type": [
+        "null",
+        "double"
+      ],
+      "name": "queryCostLast30Days",
+      "default": null,
+      "doc": "Total cost of this query in the last 30 days"
+    },
+    {
+      "Searchable": {
+        "fieldName": "runsPercentileLast30days"
+      },
+      "type": [
+        "null",
+        "int"
+      ],
+      "name": "runsPercentileLast30days",
+      "default": null,
+      "doc": "The percentile rank of this query based on runs last 30 days"
+    },
+    {
+      "Searchable": {
+        "fieldName": "lastExecutedAtFeature",
+        "fieldType": "DATETIME"
+      },
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "lastExecutedAt",
+      "default": null,
+      "doc": "Last time this query was executed"
+    }
+  ]
+}

acryl_datahub_cloud/metadata/schemas/QueryUsageStatistics.avsc

@@ -0,0 +1,221 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "queryUsageStatistics",
+    "type": "timeseries"
+  },
+  "name": "QueryUsageStatistics",
+  "namespace": "com.linkedin.pegasus2avro.query",
+  "fields": [
+    {
+      "type": "long",
+      "name": "timestampMillis",
+      "doc": "The event timestamp field as epoch at UTC in milli seconds."
+    },
+    {
+      "type": [
+        "null",
+        {
+          "type": "record",
+          "name": "TimeWindowSize",
+          "namespace": "com.linkedin.pegasus2avro.timeseries",
+          "fields": [
+            {
+              "type": {
+                "type": "enum",
+                "name": "CalendarInterval",
+                "namespace": "com.linkedin.pegasus2avro.timeseries",
+                "symbols": [
+                  "SECOND",
+                  "MINUTE",
+                  "HOUR",
+                  "DAY",
+                  "WEEK",
+                  "MONTH",
+                  "QUARTER",
+                  "YEAR"
+                ]
+              },
+              "name": "unit",
+              "doc": "Interval unit such as minute/hour/day etc."
+            },
+            {
+              "type": "int",
+              "name": "multiple",
+              "default": 1,
+              "doc": "How many units. Defaults to 1."
+            }
+          ],
+          "doc": "Defines the size of a time window."
+        }
+      ],
+      "name": "eventGranularity",
+      "default": null,
+      "doc": "Granularity of the event if applicable"
+    },
+    {
+      "type": [
+        {
+          "type": "record",
+          "name": "PartitionSpec",
+          "namespace": "com.linkedin.pegasus2avro.timeseries",
+          "fields": [
+            {
+              "TimeseriesField": {},
+              "type": "string",
+              "name": "partition",
+              "doc": "A unique id / value for the partition for which statistics were collected,\ngenerated by applying the key definition to a given row."
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "TimeWindow",
+                  "namespace": "com.linkedin.pegasus2avro.timeseries",
+                  "fields": [
+                    {
+                      "type": "long",
+                      "name": "startTimeMillis",
+                      "doc": "Start time as epoch at UTC."
+                    },
+                    {
+                      "type": "com.linkedin.pegasus2avro.timeseries.TimeWindowSize",
+                      "name": "length",
+                      "doc": "The length of the window."
+                    }
+                  ]
+                }
+              ],
+              "name": "timePartition",
+              "default": null,
+              "doc": "Time window of the partition, if we are able to extract it from the partition key."
+            },
+            {
+              "deprecated": true,
+              "type": {
+                "type": "enum",
+                "name": "PartitionType",
+                "namespace": "com.linkedin.pegasus2avro.timeseries",
+                "symbols": [
+                  "FULL_TABLE",
+                  "QUERY",
+                  "PARTITION"
+                ]
+              },
+              "name": "type",
+              "default": "PARTITION",
+              "doc": "Unused!"
+            }
+          ],
+          "doc": "A reference to a specific partition in a dataset."
+        },
+        "null"
+      ],
+      "name": "partitionSpec",
+      "default": {
+        "partition": "FULL_TABLE_SNAPSHOT",
+        "type": "FULL_TABLE",
+        "timePartition": null
+      },
+      "doc": "The optional partition specification."
+    },
+    {
+      "type": [
+        "null",
+        "string"
+      ],
+      "name": "messageId",
+      "default": null,
+      "doc": "The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value."
+    },
+    {
+      "TimeseriesField": {},
+      "type": [
+        "null",
+        "int"
+      ],
+      "name": "queryCount",
+      "default": null,
+      "doc": "Total query count in this bucket"
+    },
+    {
+      "TimeseriesField": {},
+      "type": [
+        "null",
+        "double"
+      ],
+      "name": "queryCost",
+      "default": null,
+      "doc": "Query cost for this query and bucket"
+    },
+    {
+      "TimeseriesField": {},
+      "type": [
+        "null",
+        "long"
+      ],
+      "name": "lastExecutedAt",
+      "default": null,
+      "doc": "Last executed timestamp"
+    },
+    {
+      "TimeseriesField": {},
+      "type": [
+        "null",
+        "int"
+      ],
+      "name": "uniqueUserCount",
+      "default": null,
+      "doc": "Unique user count"
+    },
+    {
+      "TimeseriesFieldCollection": {
+        "key": "user"
+      },
+      "type": [
+        "null",
+        {
+          "type": "array",
+          "items": {
+            "type": "record",
+            "name": "DatasetUserUsageCounts",
+            "namespace": "com.linkedin.pegasus2avro.dataset",
+            "fields": [
+              {
+                "java": {
+                  "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                },
+                "type": "string",
+                "name": "user",
+                "doc": "The unique id of the user.",
+                "Urn": "Urn"
+              },
+              {
+                "TimeseriesField": {},
+                "type": "int",
+                "name": "count",
+                "doc": "Number of times the dataset has been used by the user."
+              },
+              {
+                "TimeseriesField": {},
+                "type": [
+                  "null",
+                  "string"
+                ],
+                "name": "userEmail",
+                "default": null,
+                "doc": "If user_email is set, we attempt to resolve the user's urn upon ingest"
+              }
+            ],
+            "doc": "Records a single user's usage counts for a given resource"
+          }
+        }
+      ],
+      "name": "userCounts",
+      "default": null,
+      "doc": "Users within this bucket, with frequency counts"
+    }
+  ],
+  "doc": "Stats corresponding to dataset's usage."
+}

acryl_datahub_cloud/metadata/schemas/RecommendationModule.avsc

@@ -0,0 +1,259 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "recommendationModule"
+  },
+  "name": "RecommendationModule",
+  "namespace": "com.linkedin.pegasus2avro.metadata.recommendation",
+  "fields": [
+    {
+      "type": "string",
+      "name": "title",
+      "doc": "Title of the module to display"
+    },
+    {
+      "type": "string",
+      "name": "moduleId",
+      "doc": "Unique id of the module being recommended"
+    },
+    {
+      "type": {
+        "type": "enum",
+        "symbolDocs": {
+          "DOMAIN_SEARCH_LIST": "List of domains to search",
+          "ENTITY_NAME_LIST": "Simple list of entities",
+          "GLOSSARY_TERM_SEARCH_LIST": "Glossary term search list",
+          "PLATFORM_SEARCH_LIST": "List of platforms to search",
+          "SEARCH_QUERY_LIST": "A list of recommended searches",
+          "TAG_SEARCH_LIST": "Tag search list"
+        },
+        "name": "RecommendationRenderType",
+        "namespace": "com.linkedin.pegasus2avro.metadata.recommendation",
+        "symbols": [
+          "ENTITY_NAME_LIST",
+          "PLATFORM_SEARCH_LIST",
+          "TAG_SEARCH_LIST",
+          "GLOSSARY_TERM_SEARCH_LIST",
+          "SEARCH_QUERY_LIST",
+          "DOMAIN_SEARCH_LIST"
+        ],
+        "doc": "Enum that defines how the modules should be rendered.\nThere should be two frontend implementation of large and small modules per type."
+      },
+      "name": "renderType",
+      "doc": "Type of rendering that defines how the module should be rendered"
+    },
+    {
+      "type": {
+        "type": "array",
+        "items": {
+          "type": "record",
+          "name": "RecommendationContent",
+          "namespace": "com.linkedin.pegasus2avro.metadata.recommendation",
+          "fields": [
+            {
+              "type": "string",
+              "name": "value",
+              "doc": "String representation of content"
+            },
+            {
+              "java": {
+                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+              },
+              "type": [
+                "null",
+                "string"
+              ],
+              "name": "entity",
+              "default": null,
+              "doc": "Entity being recommended. Empty if the content being recommended is not an entity",
+              "Urn": "Urn"
+            },
+            {
+              "type": [
+                "null",
+                {
+                  "type": "record",
+                  "name": "RecommendationParams",
+                  "namespace": "com.linkedin.pegasus2avro.metadata.recommendation",
+                  "fields": [
+                    {
+                      "type": [
+                        "null",
+                        {
+                          "type": "record",
+                          "name": "SearchParams",
+                          "namespace": "com.linkedin.pegasus2avro.metadata.recommendation",
+                          "fields": [
+                            {
+                              "type": {
+                                "type": "array",
+                                "items": "string"
+                              },
+                              "name": "types",
+                              "default": [],
+                              "doc": "Entity types to be searched. If this is not provided, all entities will be searched."
+                            },
+                            {
+                              "type": "string",
+                              "name": "query",
+                              "doc": "Search query"
+                            },
+                            {
+                              "type": {
+                                "type": "array",
+                                "items": {
+                                  "type": "record",
+                                  "name": "Criterion",
+                                  "namespace": "com.linkedin.pegasus2avro.metadata.query.filter",
+                                  "fields": [
+                                    {
+                                      "type": "string",
+                                      "name": "field",
+                                      "doc": "The name of the field that the criterion refers to"
+                                    },
+                                    {
+                                      "type": "string",
+                                      "name": "value",
+                                      "doc": "The value of the intended field"
+                                    },
+                                    {
+                                      "type": {
+                                        "type": "array",
+                                        "items": "string"
+                                      },
+                                      "name": "values",
+                                      "default": [],
+                                      "doc": "Values. one of which the intended field should match\nNote, if values is set, the above \"value\" field will be ignored"
+                                    },
+                                    {
+                                      "type": {
+                                        "type": "enum",
+                                        "symbolDocs": {
+                                          "ANCESTORS_INCL": "Represent the relation: URN field matches any nested parent in addition to the given URN",
+                                          "BETWEEN": "Represent the relation within an inclusive range, e.g. 3 <= ownerCount <= 5. Note that the values in Criterion must have two entries for a lower and upper bound.",
+                                          "CONTAIN": "Represent the relation: String field contains value, e.g. name contains Profile",
+                                          "DESCENDANTS_INCL": "Represent the relation: URN field any nested children in addition to the given URN",
+                                          "END_WITH": "Represent the relation: String field ends with value, e.g. name ends with Event",
+                                          "EQUAL": "Represent the relation: field = value, e.g. platform = hdfs",
+                                          "EXISTS": "Represents the relation: field exists and is non-empty, e.g. owners is not null and != [] (empty)",
+                                          "GREATER_THAN": "Represent the relation greater than, e.g. ownerCount > 5",
+                                          "GREATER_THAN_OR_EQUAL_TO": "Represent the relation greater than or equal to, e.g. ownerCount >= 5",
+                                          "IEQUAL": "Represent the relation: field = value and support case insensitive values, e.g. platform = hdfs",
+                                          "IN": "Represent the relation: String field is one of the array values to, e.g. name in [\"Profile\", \"Event\"]",
+                                          "IS_NULL": "Represent the relation: field is null, e.g. platform is null",
+                                          "LESS_THAN": "Represent the relation less than, e.g. ownerCount < 3",
+                                          "LESS_THAN_OR_EQUAL_TO": "Represent the relation less than or equal to, e.g. ownerCount <= 3",
+                                          "RELATED_INCL": "Represent the relation: URN field matches any nested child or parent in addition to the given URN",
+                                          "START_WITH": "Represent the relation: String field starts with value, e.g. name starts with PageView"
+                                        },
+                                        "name": "Condition",
+                                        "namespace": "com.linkedin.pegasus2avro.metadata.query.filter",
+                                        "symbols": [
+                                          "CONTAIN",
+                                          "END_WITH",
+                                          "EQUAL",
+                                          "IEQUAL",
+                                          "IS_NULL",
+                                          "EXISTS",
+                                          "GREATER_THAN",
+                                          "GREATER_THAN_OR_EQUAL_TO",
+                                          "IN",
+                                          "LESS_THAN",
+                                          "LESS_THAN_OR_EQUAL_TO",
+                                          "BETWEEN",
+                                          "START_WITH",
+                                          "DESCENDANTS_INCL",
+                                          "ANCESTORS_INCL",
+                                          "RELATED_INCL"
+                                        ],
+                                        "doc": "The matching condition in a filter criterion"
+                                      },
+                                      "name": "condition",
+                                      "default": "EQUAL",
+                                      "doc": "The condition for the criterion, e.g. EQUAL, START_WITH"
+                                    },
+                                    {
+                                      "type": "boolean",
+                                      "name": "negated",
+                                      "default": false,
+                                      "doc": "Whether the condition should be negated"
+                                    }
+                                  ],
+                                  "doc": "A criterion for matching a field with given value"
+                                }
+                              },
+                              "name": "filters",
+                              "default": [],
+                              "doc": "Filters"
+                            }
+                          ],
+                          "doc": "Context to define the search recommendations"
+                        }
+                      ],
+                      "name": "searchParams",
+                      "default": null,
+                      "doc": "Context to define the search recommendations"
+                    },
+                    {
+                      "type": [
+                        "null",
+                        {
+                          "type": "record",
+                          "name": "EntityProfileParams",
+                          "namespace": "com.linkedin.pegasus2avro.metadata.recommendation",
+                          "fields": [
+                            {
+                              "java": {
+                                "class": "com.linkedin.pegasus2avro.common.urn.Urn"
+                              },
+                              "type": "string",
+                              "name": "urn",
+                              "doc": "Urn of the entity being shown",
+                              "Urn": "Urn"
+                            }
+                          ],
+                          "doc": "Context to define the entity profile page"
+                        }
+                      ],
+                      "name": "entityProfileParams",
+                      "default": null,
+                      "doc": "Context to define the entity profile page"
+                    },
+                    {
+                      "type": [
+                        "null",
+                        {
+                          "type": "record",
+                          "name": "ContentParams",
+                          "namespace": "com.linkedin.pegasus2avro.metadata.recommendation",
+                          "fields": [
+                            {
+                              "type": "long",
+                              "name": "count",
+                              "doc": "Number of entities corresponding to the recommended content"
+                            }
+                          ],
+                          "doc": "Params about the recommended content"
+                        }
+                      ],
+                      "name": "contentParams",
+                      "default": null,
+                      "doc": "Context about the recommendation"
+                    }
+                  ],
+                  "doc": "Parameters required to render a recommendation of a given type"
+                }
+              ],
+              "name": "params",
+              "default": null,
+              "doc": "Additional context required to generate the the recommendation"
+            }
+          ],
+          "doc": "Content to display within each recommendation module"
+        }
+      },
+      "name": "content",
+      "doc": "List of content to display inside the module"
+    }
+  ]
+}

acryl_datahub_cloud/metadata/schemas/RecommendationModuleKey.avsc

@@ -0,0 +1,26 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "recommendationModuleKey",
+    "keyForEntity": "recommendationModule",
+    "entityCategory": "_unset_",
+    "entityAspects": [
+      "recommendationModule"
+    ]
+  },
+  "name": "RecommendationModuleKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "moduleId",
+      "doc": "Module ID for the recommendation module"
+    },
+    {
+      "type": "string",
+      "name": "identifier",
+      "doc": "Identifier for the specific module"
+    }
+  ],
+  "doc": "Key for a recommendation module"
+}

acryl_datahub_cloud/metadata/schemas/RemoteExecutorKey.avsc

@@ -0,0 +1,21 @@
+{
+  "type": "record",
+  "Aspect": {
+    "name": "dataHubRemoteExecutorKey",
+    "keyForEntity": "dataHubRemoteExecutor",
+    "entityCategory": "internal",
+    "entityAspects": [
+      "dataHubRemoteExecutorStatus"
+    ]
+  },
+  "name": "RemoteExecutorKey",
+  "namespace": "com.linkedin.pegasus2avro.metadata.key",
+  "fields": [
+    {
+      "type": "string",
+      "name": "id",
+      "doc": "A unique id for the DataHub Remote Executor."
+    }
+  ],
+  "doc": "Key for an DataHub Remote Executor"
+}