sqlui 0.1.45 → 0.1.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0868cb367e107f12cd91368ae75b8fb7a3c07e560314cb4cef53f383098a8882'
-  data.tar.gz: 5268a086e9a3436f0e3e421d41dd54fc1ebb11fff9942ff0a6e25c36863ffde1
+  metadata.gz: 01c105468ea4c5f463ada429231bd41a3a65752d8fa95f8befa2121a47765fbe
+  data.tar.gz: 6e0df11aa97b0e8d0d685e6b109a297c8ddba78959f109db26f7b159aa4cfa0c
 SHA512:
-  metadata.gz: b9b7368e050c3aa4cce48c875347d2eeaa59c8fd33ee48f1e95addafc377f433a2fd6d16d26add6e0fe477c139ec2d300c26963ab34a2469e02b500123c34bcf
-  data.tar.gz: 75c25197021f06d7d1cbc14516f254760c63f0830e55f86226a772d53ab7b23b10d62ab790c0bbca031d2a78795c9b4185a2467e5748eb00fdf84762b42fdf04
+  metadata.gz: 6c1fd32e0feb8817bac5e120a15e71adf48e9ccbe5183e0ba729dc29c1a2bb76ffa18bd7c63559dd49f66f0eb8a3669213988701da8c3f4d4566919985c80c13
+  data.tar.gz: 022b592a3ed56c7e06b8222566cfe7d096ed1b1789d687afe4bf945e625a390269dffd8a701fa4647377e85399b40e345147ea637113a2489e31fbd2630e409a

data/.version

@@ -1 +1 @@
-0.1.45
+0.1.47

data/app/database_config.rb

@@ -8,7 +8,7 @@ require_relative 'args'
 
 # Config for a single database.
 class DatabaseConfig
-  attr_reader :display_name, :description, :url_path, :joins, :saved_path, :table_aliases, :client_params
+  attr_reader :display_name, :description, :url_path, :joins, :saved_path, :tables, :client_params
 
   def initialize(hash)
     @display_name = Args.fetch_non_empty_string(hash, :display_name).strip
@@ -27,12 +27,25 @@ class DatabaseConfig
 
       raise ArgumentError, "invalid join #{join.to_json}"
     end
-    @table_aliases = Args.fetch_optional_hash(hash, :table_aliases) || {}
-    @table_aliases = @table_aliases.each do |table, a|
-      raise ArgumentError, "invalid alias for table #{table} (#{a}), expected string" unless a.is_a?(String)
+    @tables = Args.fetch_optional_hash(hash, :tables) || {}
+    @tables = @tables.each do |table, table_config|
+      unless table_config.is_a?(Hash)
+        raise ArgumentError, "invalid table config for #{table} (#{table_config}), expected hash"
+      end
+
+      table_alias = table_config[:alias]
+      if table_alias && !table_alias.is_a?(String)
+        raise ArgumentError, "invalid table alias for #{table} (#{table_alias}), expected string"
+      end
+
+      table_boost = table_config[:boost]
+      if table_boost && !table_boost.is_a?(Integer)
+        raise ArgumentError, "invalid table boost for #{table} (#{table_boost}), expected int"
+      end
     end
-    duplicate_aliases = @table_aliases.reject { |(_, v)| @table_aliases.values.count(v) == 1 }.to_h.values.to_set
-    if @table_aliases.values.to_set.size < @table_aliases.values.size
+    aliases = @tables.map { |_table, table_config| table_config[:alias] }.compact
+    if aliases.to_set.size < aliases.size
+      duplicate_aliases = aliases.reject { |a| aliases.count(a) == 1 }.to_set
       raise ArgumentError, "duplicate table aliases: #{duplicate_aliases.join(', ')}"
     end
 

data/app/server.rb

@@ -6,7 +6,6 @@ require 'erb'
 require 'json'
 require 'sinatra/base'
 require 'uri'
-require 'webrick/log'
 require_relative 'database_metadata'
 require_relative 'mysql_types'
 require_relative 'sql_parser'
@@ -14,6 +13,10 @@ require_relative 'sqlui'
 
 # SQLUI Sinatra server.
 class Server < Sinatra::Base
+  def self.logger
+    @logger ||= WEBrick::Log.new
+  end
+
   def self.init_and_run(config, resources_dir)
     Mysql2::Client.default_query_options[:as] = :array
     Mysql2::Client.default_query_options[:cast_booleans] = true
@@ -27,8 +30,6 @@ class Server < Sinatra::Base
     set :raise_errors,    false
     set :show_exceptions, false
 
-    logger = WEBrick::Log.new
-
     get '/-/health' do
       status 200
       body 'OK'
@@ -67,7 +68,7 @@ class Server < Sinatra::Base
             server: "#{config.name} - #{database.display_name}",
             list_url_path: config.list_url_path,
             schemas: DatabaseMetadata.lookup(client, database),
-            table_aliases: database.table_aliases,
+            tables: database.tables,
             joins: database.joins,
             saved: Dir.glob("#{database.saved_path}/*.sql").to_h do |path|
               contents = File.read(path)
@@ -99,35 +100,45 @@ class Server < Sinatra::Base
         variables = params[:variables] || {}
         sql = find_selected_query(params[:sql], params[:selection])
 
-        result = database.with_client do |client|
-          query_result = execute_query(client, variables, sql)
-          # NOTE: the call to result.field_types must go before other interaction with the result. Otherwise you will
-          # get a seg fault. Seems to be a bug in Mysql2.
-          # TODO: stream this and render results on the client as they are returned?
-          {
-            columns: query_result.fields,
-            column_types: MysqlTypes.map_to_google_charts_types(query_result.field_types),
-            total_rows: query_result.size,
-            rows: (query_result.to_a || []).take(Sqlui::MAX_ROWS)
-          }
-        end
-
-        result[:selection] = params[:selection]
-        result[:query] = params[:sql]
-
         status 200
         headers 'Content-Type' => 'application/json; charset=utf-8'
-        body result.to_json
+
+        database.with_client do |client|
+          query_result = execute_query(client, variables, sql)
+          stream do |out|
+            json = <<~RES.chomp
+              {
+                "columns": #{query_result.fields.to_json},
+                "column_types": #{MysqlTypes.map_to_google_charts_types(query_result.field_types).to_json},
+                "total_rows": #{query_result.size.to_json},
+                "selection": #{params[:selection].to_json},
+                "query": #{params[:sql].to_json},
+                "rows": [
+            RES
+            out << json
+            bytes = json.bytesize
+            query_result.each_with_index do |row, i|
+              json = "#{i.zero? ? '' : ','}\n    #{row.to_json}"
+              bytes += json.bytesize
+              break if i == Sqlui::MAX_ROWS || bytes > Sqlui::MAX_BYTES
+
+              out << json
+            end
+            out << <<~RES
+
+                ]
+              }
+            RES
+          end
+        end
       end
 
       get "#{database.url_path}/download_csv" do
         break client_error('missing sql') unless params[:sql]
 
         sql = Base64.decode64(params[:sql]).force_encoding('UTF-8')
-        logger.info "sql: #{sql}"
         variables = params.map { |k, v| k[0] == '_' ? [k, v] : nil }.compact.to_h
         sql = find_selected_query(sql, params[:selection])
-        logger.info "sql: #{sql}"
 
         content_type 'application/csv; charset=utf-8'
         attachment 'result.csv'

data/app/sqlui.rb

@@ -6,6 +6,7 @@ require_relative 'server'
 # Main entry point.
 class Sqlui
   MAX_ROWS = 10_000
+  MAX_BYTES = 10 * 1_024 * 1_024
 
   def initialize(config_file)
     raise 'you must specify a configuration file' unless config_file

data/client/resources/sqlui.js

@@ -23995,19 +23995,20 @@
      const schemas = Object.entries(window.metadata.schemas);
      const editorSchema = {};
      const tables = [];
-     const hasTableAliases = Object.keys(window.metadata.table_aliases).length > 0;
      schemas.forEach(([schemaName, schema]) => {
        Object.entries(schema.tables).forEach(([tableName, table]) => {
          const qualifiedTableName = schemas.length === 1 ? tableName : `${schemaName}.${tableName}`;
          const quotedQualifiedTableName = schemas.length === 1 ? `\`${tableName}\`` : `\`${schemaName}\`.\`${tableName}\``;
          const columns = Object.keys(table.columns);
          editorSchema[qualifiedTableName] = columns;
-         const alias = window.metadata.table_aliases[qualifiedTableName];
+         const alias = window.metadata.tables[qualifiedTableName]?.alias;
+         const boost = window.metadata.tables[qualifiedTableName]?.boost;
          if (alias) {
            editorSchema[alias] = columns;
            tables.push({
              label: qualifiedTableName,
              detail: alias,
+             boost,
              alias_type: 'with',
              quoted: `${quotedQualifiedTableName} \`${alias}\``,
              unquoted: `${qualifiedTableName} ${alias}`
@@ -24015,6 +24016,7 @@
            tables.push({
              label: qualifiedTableName,
              detail: alias,
+             boost,
              alias_type: 'only',
              quoted: '`' + alias + '`',
              unquoted: alias
@@ -24090,7 +24092,7 @@
          MySQL.language.data.of({
            autocomplete: (context) => {
              const result = originalSchemaCompletionSource(context);
-             if (!hasTableAliases || !result?.options) return result
+             if (!result?.options) return result
 
              const tree = syntaxTree(context.state);
              let node = tree.resolveInner(context.pos, -1);
@@ -24164,10 +24166,19 @@
                if (foundSchema) {
                  const unquotedLabel = unquoteSqlId(option.label);
                  const quoted = unquotedLabel !== option.label;
-                 const alias = window.metadata.table_aliases[`${foundSchema}.${unquotedLabel}`];
+                 const tableConfig = window.metadata.tables[`${foundSchema}.${unquotedLabel}`];
+                 const alias = tableConfig?.alias;
+                 const boost = tableConfig?.boost || -1;
+                 const optionOverride = {
+                   label: option.label
+                 };
                  if (alias) {
-                   option = { label: quoted ? `\`${unquotedLabel}\` \`${alias}\`` : `${option.label} ${alias}` };
+                   optionOverride.label = quoted ? `\`${unquotedLabel}\` \`${alias}\`` : `${option.label} ${alias}`;
                  }
+                 if (boost) {
+                   optionOverride.boost = boost;
+                 }
+                 if (alias || boost) return optionOverride
                }
                return option
              });

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqlui
 version: !ruby/object:Gem::Version
-  version: 0.1.45
+  version: 0.1.47
 platform: ruby
 authors:
 - Nick Dower
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-20 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2