superset 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eccf34d9aa2007200762969b6483106b398d889027e7913b393c5a1386678106
-  data.tar.gz: 18a65c328bb022afaf81e1482af324ee8ce90f9dfadf9af710723cfbd727e11d
+  metadata.gz: 565da0973df5cfd3aa9f1c555f477a9a9d710870c143ea2ca1678ff85febf3e6
+  data.tar.gz: 75620c8a9459443001e1b0ea62ccc5375f77d7bf5eb7b6bc6705bb840ed73b36
 SHA512:
-  metadata.gz: 4728bc69910b3d6e911bd863bf7a9bee973287e367bc2d95b328a0ae2bf01499a4e1647dc0ea97303d0009a4d055c8dbf847bf24f2afc224056b4d42d4b7825c
-  data.tar.gz: 66d21dfaef3abee7cf51eb02780f17205e2cd4f9173148033f500b26363cb236633c6fc884e7d830d38a4655c1fcff4b3e598886c4a1e500ef07368434ef4575
+  metadata.gz: 754a540a0a88322c7b63efce92ab04d44d3aaaebdd865f12ff7397414804e39a9e3a2586a6cfad0e26e0681fd556d22bc23b515ad69f7bc8ecdfd0a2f8aeb7b0
+  data.tar.gz: 4c1f810364a9389712183eabb06c81d473a634d8e6f6306d3b7b4b312818ad872df252f071f6b29df73cf622ebc3d0db37f009a0600a83358c464832a3f607c9

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Change Log
 
+## 0.3.3 - 2025-12-11
+* Add databases method to Superset::Dashboard::Datasets::List
+* New class to get Superset::Database::Connection details
+
 ## 0.3.2 - 2025-11-28
 * Add require happi
 

data/lib/superset/chart/list.rb

@@ -2,12 +2,13 @@ module Superset
   module Chart
     class List < Superset::Request
 
-      attr_reader :title_contains, :dashboard_id_eq, :dataset_id_eq
+      attr_reader :title_contains, :dashboard_id_eq, :dataset_id_eq, :owner_id_eq
 
-      def initialize(title_contains: '', dashboard_id_eq: '', dataset_id_eq: '', **kwargs)
+      def initialize(title_contains: '', dashboard_id_eq: '', dataset_id_eq: '', owner_id_eq: '', **kwargs)
         @title_contains = title_contains
         @dashboard_id_eq = dashboard_id_eq
         @dataset_id_eq = dataset_id_eq
+        @owner_id_eq = owner_id_eq
         super(**kwargs)
       end
 
@@ -41,6 +42,7 @@ module Superset
         filter_set << "(col:slice_name,opr:ct,value:'#{title_contains}')" if title_contains.present?
         filter_set << "(col:dashboards,opr:rel_m_m,value:#{dashboard_id_eq})" if dashboard_id_eq.present? # rel many to many
         filter_set << "(col:datasource_id,opr:eq,value:#{dataset_id_eq})" if dataset_id_eq.present?
+        filter_set << "(col:owners,opr:rel_m_m,value:#{owner_id_eq})" if owner_id_eq.present?
 
         unless filter_set.empty?
           "filters:!(" + filter_set.join(',') + "),"

data/lib/superset/dashboard/bulk_delete_cascade.rb

@@ -21,8 +21,8 @@ module Superset
 
         dashboard_ids.sort.each do |dashboard_id|
           logger.info("Dashboard Id: #{dashboard_id.to_s} Attempting CASCADE delete of dashboard, charts, datasets")
-          delete_datasets(dashboard_id)
           delete_charts(dashboard_id)
+          delete_datasets(dashboard_id)
           delete_dashboard(dashboard_id)
         end
         true

data/lib/superset/dashboard/cascade_ownership/add_new_owner.rb

@@ -36,7 +36,7 @@ module Superset
         end
 
         def add_user_to_datasets_ownership
-          dataset_ids = Superset::Dashboard::Datasets::List.new(dashboard_id: dashboard_id).ids
+          dataset_ids = Superset::Dashboard::Datasets::List.new(dashboard_id: dashboard_id, include_filter_datasets: true).ids
           dataset_ids.each do |dataset_id|
             current_dataset_owner_ids = Superset::Dataset::Get.new(dataset_id).result['owners'].map{|c| c['id']}
             next if current_dataset_owner_ids.include?(user_id)
@@ -51,4 +51,4 @@ module Superset
       end
     end
   end
-end
+end

data/lib/superset/dashboard/datasets/list.rb

@@ -7,15 +7,12 @@ module Superset
   module Dashboard
     module Datasets
       class List < Superset::Request
-        attr_reader :id, :include_filter_datasets # id - dashboard id
+        attr_reader :dashboard_id, :include_filter_datasets, :include_catalog_lookup # id - dashboard id
 
-        def self.call(id)
-          self.new(id).list
-        end
-
-        def initialize(dashboard_id:, include_filter_datasets: false)
-          @id = dashboard_id
+        def initialize(dashboard_id:, include_filter_datasets: false, include_catalog_lookup: false)
+          @dashboard_id = dashboard_id
           @include_filter_datasets = include_filter_datasets
+          @include_catalog_lookup = include_catalog_lookup
         end
 
         def perform
@@ -23,29 +20,24 @@ module Superset
           self
         end
 
-        def schemas
-          @schemas ||= begin
-            all_dashboard_schemas = datasets_details.map {|d| d[:schema] }.uniq
-
-            # For the current superset setup we will assume a dashboard datasets will point to EXACTLY one schema, their own.
-            # if not .. we need to know about it. Potentially we could override this check if others do not consider it a problem.
-            if all_dashboard_schemas.count > 1
-              Rollbar.error("SUPERSET DASHBOARD ERROR: Dashboard id #{id} has multiple dataset schema linked: #{all_dashboard_schemas.to_s}") if defined?(Rollbar)
-            end
-            all_dashboard_schemas
+        def datasets_details
+          @datasets_details ||= begin
+            datasets_list = chart_datasets + additional_filter_datasets
+            datasets_list = include_catalog_details(datasets_list) if include_catalog_lookup
+            datasets_list.compact
           end
         end
 
-        def datasets_details
-          chart_datasets = result.map do |details|
-            details.slice('id', 'datasource_name', 'schema', 'sql').merge('database' => details['database'].slice('id', 'name', 'backend')).with_indifferent_access
-          end
-          return chart_datasets unless include_filter_datasets
-          chart_dataset_ids = chart_datasets.map{|d| d['id'] }
-          filter_dataset_ids_not_used_in_charts = filter_dataset_ids - chart_dataset_ids
-          return chart_datasets if filter_dataset_ids_not_used_in_charts.empty?
-          # returning chart and filter datasets
-          chart_datasets + filter_datasets(filter_dataset_ids_not_used_in_charts)
+        def databases
+          @databases ||= datasets_details.map {|d| d[:database] }.uniq
+        end
+
+        def catalogs
+          datasets_details.map {|d| d[:catalog] }.compact.uniq
+        end
+
+        def schemas
+          datasets_details.map {|d| d[:schema] }.compact.uniq
         end
 
         def rows
@@ -64,24 +56,47 @@ module Superset
 
         private
 
+        def include_catalog_details(datasets_list)
+          datasets_list.each {|d| d[:catalog] = Superset::Dataset::Get.new(d[:id].to_i).result['catalog'] }
+        end
+
+        # list of chart dataset details used in the dashboard
+        def chart_datasets
+          result.map do |details|
+            details.slice('id', 'datasource_name', 'schema', 'sql').merge('database' => details['database'].slice('id', 'name', 'backend')).with_indifferent_access
+          end
+        end
+
+        # list of any additional filter dataset details on the dashboard that are not used in charts
+        def additional_filter_datasets
+          return [] unless include_filter_datasets
+
+          chart_dataset_ids = chart_datasets.map{|d| d['id'] }
+          filter_dataset_ids_not_used_in_charts = filter_dataset_ids - chart_dataset_ids
+          retrieve_filter_datasets(filter_dataset_ids_not_used_in_charts) unless filter_dataset_ids_not_used_in_charts.empty?
+        end
+
         def filter_dataset_ids
           @filter_dataset_ids ||= dashboard.filter_configuration.map { |c| c['targets'] }.flatten.compact.map { |c| c['datasetId'] }.flatten.compact.uniq
         end
 
-        def filter_datasets(filter_dataset_ids_not_used_in_charts)
+        def retrieve_filter_datasets(filter_dataset_ids_not_used_in_charts)
           filter_dataset_ids_not_used_in_charts.map do |filter_dataset_id|
             filter_dataset = Superset::Dataset::Get.new(filter_dataset_id).result
-            database_info = {
-              'id' => filter_dataset['database']['id'],
-              'name' => filter_dataset['database']['database_name'],
-              'backend' => filter_dataset['database']['backend']
-            }
-            filter_dataset.slice('id', 'datasource_name', 'schema', 'sql').merge('database' => database_info, 'filter_only': true).with_indifferent_access
+            { id: filter_dataset_id,
+              datasource_name: filter_dataset['datasource_name'],
+              schema: filter_dataset['schema'],
+              sql: filter_dataset['sql'],
+              database: {
+                'id' => filter_dataset['database']['id'],
+                'name' => filter_dataset['database']['database_name'],
+                'backend' => filter_dataset['database']['backend'] },
+              filter_only: true }.with_indifferent_access
           end
         end
 
         def route
-          "dashboard/#{id}/datasets"
+          "dashboard/#{dashboard_id}/datasets"
         end
 
         def list_attributes
@@ -90,11 +105,11 @@ module Superset
 
         # when displaying a list of datasets, show dashboard title as well
         def title
-          @title ||= [id, dashboard.title].join(' ')
+          @title ||= [dashboard_id, dashboard.title].join(' ')
         end
 
         def dashboard
-          @dashboard ||= Superset::Dashboard::Get.new(id)
+          @dashboard ||= Superset::Dashboard::Get.new(dashboard_id)
         end
       end
     end

data/lib/superset/dashboard/list.rb

@@ -7,14 +7,15 @@ module Superset
     class List < Superset::Request
       attr_reader :title_contains, :title_equals,
                   :tags_contain, :tags_equal,
-                  :ids_not_in, :include_filter_dataset_schemas
+                  :ids_not_in, :owner_id_eq, :include_filter_dataset_schemas
 
-      def initialize(title_contains: '', title_equals: '', tags_contain: [], tags_equal: [], ids_not_in: [], include_filter_dataset_schemas: false, **kwargs)
+      def initialize(title_contains: '', title_equals: '', tags_contain: [], tags_equal: [], ids_not_in: [], owner_id_eq: '', include_filter_dataset_schemas: false, **kwargs)
         @title_contains = title_contains
         @title_equals = title_equals
         @tags_contain = tags_contain
         @tags_equal = tags_equal
         @ids_not_in = ids_not_in
+        @owner_id_eq = owner_id_eq
         @include_filter_dataset_schemas = include_filter_dataset_schemas
         super(**kwargs)
       end
@@ -86,6 +87,7 @@ module Superset
         filter_set << tags_contain_filters if tags_contain.present?
         filter_set << tags_equal_filters if tags_equal.present?
         filter_set << ids_not_in_filters if ids_not_in.present?
+        filter_set << "(col:owners,opr:rel_m_m,value:#{owner_id_eq})" if owner_id_eq.present?
 
         unless filter_set.empty?
           "filters:!(" + filter_set.join(',') + "),"

data/lib/superset/database/connection.rb

@@ -0,0 +1,26 @@
+module Superset
+  module Database
+    class Connection < Superset::Request
+
+      attr_reader :id
+
+      def initialize(id)
+        @id = id
+      end
+
+      def self.call(id)
+        self.new(id).result
+      end
+
+      def connection_db_name
+        result['parameters']['database']
+      end
+
+      private
+
+      def route
+        "database/#{id}/connection"
+      end
+    end
+  end
+end

data/lib/superset/dataset/list.rb

@@ -1,13 +1,14 @@
 module Superset
   module Dataset
     class List < Superset::Request
-      attr_reader :title_contains, :title_equals, :schema_equals, :database_id_eq
+      attr_reader :title_contains, :title_equals, :schema_equals, :database_id_eq, :owner_id_eq
 
-      def initialize(title_contains: '', title_equals: '', schema_equals: '', database_id_eq: '', **kwargs)
+      def initialize(title_contains: '', title_equals: '', schema_equals: '', database_id_eq: '', owner_id_eq: '', **kwargs)
         @title_contains = title_contains
         @title_equals = title_equals
         @schema_equals = schema_equals
         @database_id_eq = database_id_eq
+        @owner_id_eq = owner_id_eq
         super(**kwargs)
       end
 
@@ -28,6 +29,8 @@ module Superset
         filters << "(col:table_name,opr:eq,value:'#{title_equals}')" if title_equals.present?
         filters << "(col:schema,opr:eq,value:'#{schema_equals}')" if schema_equals.present?
         filters << "(col:database,opr:rel_o_m,value:#{database_id_eq})" if database_id_eq.present? # rel one to many
+        filters << "(col:owners,opr:rel_m_m,value:#{owner_id_eq})" if owner_id_eq.present?
+
         unless filters.empty?
           "filters:!(" + filters.join(',') + "),"
         end

data/lib/superset/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Superset
-  VERSION = "0.3.2"
+  VERSION = "0.3.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: superset
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - jbat
@@ -246,6 +246,7 @@ files:
 - lib/superset/dashboard/list.rb
 - lib/superset/dashboard/put.rb
 - lib/superset/dashboard/warm_up_cache.rb
+- lib/superset/database/connection.rb
 - lib/superset/database/export.rb
 - lib/superset/database/get.rb
 - lib/superset/database/get_catalogs.rb