blazer 2.2.7 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 382b47b900346a570bb7e884eb28a8c4ce3df48c5db659bfa2dba161749ff6ea
-  data.tar.gz: 64599ca3bbc9a06c5abcabc8249021d2611b3805b22518eb5b045a008de5347a
+  metadata.gz: b2a6413e7d7d49e280cbb8d6a880ec32c6c49452e69f980183b592bd927fa90a
+  data.tar.gz: 2e988e2010ae919dbfbb7c4c922753425b16eb0ee1e6fe309789cb44a450d8f7
 SHA512:
-  metadata.gz: 565bfa960da08efa1d152c54e3f9ca1c7d2cbf6ada4e1464849c88dae33e2423fb5884366f4a6c1bab66b53acdd874e5d1033bb28c34e67f1d5930e5e47bfeda
-  data.tar.gz: a802b1465b213bd39645259b240011df0e8bc3feef7c3664771fb35b8243f9d183f0e8897e48120d85be3bea5dfe99e127d40b468acffd2b0a0d2208b2fc98ea
+  metadata.gz: 50fc2e2d4c430935e05d14df65aea648df86c4792e58007ff0f6015a5c58a5842db4f9d22d430ac7f84b094325d45c41406f67676d6ec3d3535266e47ebd53a0
+  data.tar.gz: 3118830b6ab4198fe383615c09319d98619480e2f88dca117b92e99c228da82a5556f7a9948ad57dd45e788cacc20efec370e0eb68770919e5dab9909bd4f1ef

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## 2.4.1 (2021-01-25)
+
+- Added cohorts for MySQL
+- Added support for Apache Hive and Apache Spark
+- Fixed deprecation warning with Active Record 6.1
+
+## 2.4.0 (2020-12-15)
+
+- Added cohorts
+- Fixed broken routes for some applications
+- Forecasting and uploads are no longer experimental
+
+## 2.3.1 (2020-11-23)
+
+- Improved column names for uploads
+
+## 2.3.0 (2020-11-16)
+
+- Added support for archiving queries
+- Added experimental support for uploads
+
+## 2.2.8 (2020-11-01)
+
+- Fixed error when deleting dashboard
+
 ## 2.2.7 (2020-09-07)
 
 - Use `datetime` type in migration

data/README.md

@@ -4,7 +4,7 @@ Explore your data with SQL. Easily create charts and dashboards, and share them
 
 [Try it out](https://blazer.dokkuapp.com)
 
-[![Screenshot](https://blazer.dokkuapp.com/assets/blazer-90bd7acc9fdf1f5fc2bb25bfe5506f746ec8c9d2e0730388debfd697e32f75b8.png)](https://blazer.dokkuapp.com)
+[![Screenshot](https://blazer.dokkuapp.com/assets/blazer-a10baa40fef1ca2f5bb25fc97bcf261a6a54192fb1ad0f893c0f562b8c7c4697.png)](https://blazer.dokkuapp.com)
 
 Blazer is also available as a [Docker image](https://github.com/ankane/blazer-docker).
 
@@ -25,6 +25,12 @@ Blazer is also available as a [Docker image](https://github.com/ankane/blazer-do
 - [Charts](#charts)
 - [Dashboards](#dashboards)
 - [Checks](#checks)
+- [Cohorts](#cohorts)
+- [Anomaly Detection](#anomaly-detection)
+- [Forecasting](#forecasting)
+- [Uploads](#uploads)
+- [Data Sources](#data-sources)
+- [Query Permissions](#query-permissions)
 
 ## Installation
 
@@ -383,6 +389,31 @@ SELECT * FROM ratings WHERE user_id IS NULL /* all ratings should have a user */
 
 Then create check with optional emails if you want to be notified. Emails are sent when a check starts failing, and when it starts passing again.
 
+## Cohorts
+
+Create a cohort analysis from a simple SQL query. [Example](https://blazer.dokkuapp.com/queries/19-cohort-analysis-from-first-order)
+
+Create a query with the comment `/* cohort analysis */`. The result should have columns named `user_id` and `conversion_time` and optionally `cohort_time`.
+
+You can generate cohorts from the first conversion time:
+
+```sql
+/* cohort analysis */
+SELECT user_id, created_at AS conversion_time FROM orders
+```
+
+(the first conversion isn’t counted in the first time period with this format)
+
+Or from another time, like sign up:
+
+```sql
+/* cohort analysis */
+SELECT users.id AS user_id, orders.created_at AS conversion_time, users.created_at AS cohort_time
+FROM users LEFT JOIN orders ON orders.user_id = users.id
+```
+
+This feature requires PostgreSQL or MySQL.
+
 ## Anomaly Detection
 
 Blazer supports two different approaches to anomaly detection.
@@ -428,16 +459,33 @@ anomaly_checks: r
 
 If upgrading from version 1.4 or below, also follow the [upgrade instructions](#15).
 
-If you’re on Heroku, follow [these additional instructions](#anomaly-detection-on-heroku).
+If you’re on Heroku, follow the additional instructions below.
+
+### R on Heroku
+
+Add the [R buildpack](https://github.com/virtualstaticvoid/heroku-buildpack-r) to your app.
+
+```sh
+heroku buildpacks:add --index 1 https://github.com/virtualstaticvoid/heroku-buildpack-r.git
+```
+
+And create an `init.R` with:
+
+```r
+if (!"AnomalyDetection" %in% installed.packages()) {
+  install.packages("remotes")
+  remotes::install_github("twitter/AnomalyDetection")
+}
+```
+
+Commit and deploy away. The first deploy may take a few minutes.
 
 ## Forecasting
 
-Blazer has experimental support for two different forecasting methods.
+Blazer supports for two different forecasting methods. [Example](https://blazer.dokkuapp.com/queries/18-forecast?forecast=t)
 
 A forecast link will appear for queries that return 2 columns with types timestamp and numeric.
 
-[Example](https://blazer.dokkuapp.com/queries/18-forecast?forecast=t)
-
 ### Prophet
 
 Add [prophet](https://github.com/ankane/prophet) to your Gemfile:
@@ -468,6 +516,32 @@ And add to `config/blazer.yml`:
 forecasting: trend
 ```
 
+## Uploads
+
+Creating database tables from CSV files. [Example](https://blazer.dokkuapp.com/uploads)
+
+Run:
+
+```sh
+rails generate blazer:uploads
+rails db:migrate
+```
+
+And add to `config/blazer.yml`:
+
+```yml
+uploads:
+  url: postgres://...
+  schema: uploads
+  data_source: main
+```
+
+This feature requires PostgreSQL. Create a new schema just for uploads.
+
+```sql
+CREATE SCHEMA uploads;
+```
+
 ## Data Sources
 
 Blazer supports multiple data sources :tada:
@@ -492,6 +566,8 @@ data_sources:
 - [Amazon Athena](#amazon-athena)
 - [Amazon Redshift](#amazon-redshift)
 - [Apache Drill](#apache-drill)
+- [Apache Hive](#apache-hive)
+- [Apache Spark](#apache-spark)
 - [Cassandra](#cassandra)
 - [Druid](#druid)
 - [Elasticsearch](#elasticsearch)
@@ -553,6 +629,32 @@ data_sources:
     url: http://hostname:8047
 ```
 
+### Apache Hive
+
+Add [hexspace](https://github.com/ankane/hexspace) to your Gemfile and set:
+
+```yml
+data_sources:
+  my_source:
+    adapter: hive
+    url: sasl://user:password@hostname:10000/database
+```
+
+Use a read-only user. Requires [HiveServer2](https://cwiki.apache.org/confluence/display/Hive/Setting+Up+HiveServer2).
+
+### Apache Spark
+
+Add [hexspace](https://github.com/ankane/hexspace) to your Gemfile and set:
+
+```yml
+data_sources:
+  my_source:
+    adapter: spark
+    url: sasl://user:password@hostname:10000/database
+```
+
+Use a read-only user. Requires the [Thrift server](https://spark.apache.org/docs/latest/sql-distributed-sql-engine.html).
+
 ### Cassandra
 
 Add [cassandra-driver](https://github.com/datastax/ruby-driver) to your Gemfile and set:
@@ -609,8 +711,6 @@ data_sources:
 
 ### InfluxDB
 
-*Experimental*
-
 Add [influxdb](https://github.com/influxdata/influxdb-ruby) to your Gemfile and set:
 
 ```yml
@@ -644,8 +744,6 @@ data_sources:
 
 ### Neo4j
 
-*Experimental*
-
 Add [neo4j-core](https://github.com/neo4jrb/neo4j-core) to your Gemfile and set:
 
 ```yml
@@ -687,8 +785,6 @@ data_sources:
 
 ### Salesforce
 
-*Experimental*
-
 Add [restforce](https://github.com/restforce/restforce) to your Gemfile and set:
 
 ```yml
@@ -712,8 +808,6 @@ Supports [SOQL](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta
 
 ### Socrata Open Data API (SODA)
 
-*Experimental*
-
 Set:
 
 ```yml
@@ -836,25 +930,14 @@ async: true
 config.cache_store = :mem_cache_store
 ```
 
-## Anomaly Detection on Heroku
+## Archiving
 
-Add the [R buildpack](https://github.com/virtualstaticvoid/heroku-buildpack-r) to your app.
+Archive queries that haven’t been viewed in over 90 days.
 
 ```sh
-heroku buildpacks:add --index 1 https://github.com/virtualstaticvoid/heroku-buildpack-r.git
-```
-
-And create an `init.R` with:
-
-```r
-if (!"AnomalyDetection" %in% installed.packages()) {
-  install.packages("remotes")
-  remotes::install_github("twitter/AnomalyDetection")
-}
+rake blazer:archive_queries
 ```
 
-Commit and deploy away. The first deploy may take a few minutes.
-
 ## Content Security Policy
 
 If views are stuck with a `Loading...` message, there might be a problem with strict CSP settings in your app. This can be checked with Firefox or Chrome dev tools. You can allow Blazer to override these settings for its controllers with:
@@ -865,164 +948,33 @@ override_csp: true
 
 ## Upgrading
 
-### 2.0
-
-To use Slack notifications, create a migration
-
-```sh
-rails g migration add_slack_channels_to_blazer_checks
-```
-
-with:
-
-```ruby
-add_column :blazer_checks, :slack_channels, :text
-```
-
-### 1.5
+### 2.3
 
-To take advantage of the anomaly detection, create a migration
+To archive queries, create a migration
 
 ```sh
-rails g migration upgrade_blazer_to_1_5
+rails g migration add_status_to_blazer_queries
 ```
 
 with:
 
 ```ruby
-add_column :blazer_checks, :check_type, :string
-add_column :blazer_checks, :message, :text
-commit_db_transaction
-
-Blazer::Check.reset_column_information
-
-Blazer::Check.where(invert: true).update_all(check_type: "missing_data")
-Blazer::Check.where(check_type: nil).update_all(check_type: "bad_data")
-```
-
-### 1.3
-
-To take advantage of the latest features, create a migration
-
-```sh
-rails g migration upgrade_blazer_to_1_3
+add_column :blazer_queries, :status, :string
+Blazer::Query.update_all(status: "active")
 ```
 
-with:
-
-```ruby
-add_column :blazer_dashboards, :creator_id, :integer
-add_column :blazer_checks, :creator_id, :integer
-add_column :blazer_checks, :invert, :boolean
-add_column :blazer_checks, :schedule, :string
-add_column :blazer_checks, :last_run_at, :timestamp
-commit_db_transaction
-
-Blazer::Check.update_all schedule: "1 hour"
-```
-
-### 1.0
-
-Blazer 1.0 brings a number of new features:
-
-- multiple data sources, including Redshift
-- dashboards
-- checks
-
-To upgrade, run:
-
-```sh
-bundle update blazer
-```
+### 2.0
 
-Create a migration
+To use Slack notifications, create a migration
 
 ```sh
-rails g migration upgrade_blazer_to_1_0
+rails g migration add_slack_channels_to_blazer_checks
 ```
 
 with:
 
 ```ruby
-add_column :blazer_queries, :data_source, :string
-add_column :blazer_audits, :data_source, :string
-
-create_table :blazer_dashboards do |t|
-  t.text :name
-  t.timestamps
-end
-
-create_table :blazer_dashboard_queries do |t|
-  t.references :dashboard
-  t.references :query
-  t.integer :position
-  t.timestamps
-end
-
-create_table :blazer_checks do |t|
-  t.references :query
-  t.string :state
-  t.text :emails
-  t.timestamps
-end
-```
-
-And run:
-
-```sh
-rails db:migrate
-```
-
-Update `config/blazer.yml` with:
-
-```yml
-# see https://github.com/ankane/blazer for more info
-
-data_sources:
-  main:
-    url: <%= ENV["BLAZER_DATABASE_URL"] %>
-
-    # statement timeout, in seconds
-    # applies to PostgreSQL only
-    # none by default
-    # timeout: 15
-
-    # time to cache results, in minutes
-    # can greatly improve speed
-    # none by default
-    # cache: 60
-
-    # wrap queries in a transaction for safety
-    # not necessary if you use a read-only user
-    # true by default
-    # use_transaction: false
-
-    smart_variables:
-      # zone_id: "SELECT id, name FROM zones ORDER BY name ASC"
-
-    linked_columns:
-      # user_id: "/admin/users/{value}"
-
-    smart_columns:
-      # user_id: "SELECT id, name FROM users WHERE id IN {value}"
-
-# create audits
-audit: true
-
-# change the time zone
-# time_zone: "Pacific Time (US & Canada)"
-
-# class name of the user model
-# user_class: User
-
-# method name for the current user
-# user_method: current_user
-
-# method name for the display name
-# user_name: name
-
-# email to send checks from
-# from_email: blazer@example.org
+add_column :blazer_checks, :slack_channels, :text
 ```
 
 ## History

data/app/assets/stylesheets/blazer/application.css

@@ -16,6 +16,10 @@ body {
   padding-bottom: 15px;
 }
 
+table.results-table {
+  margin-bottom: 0;
+}
+
 .results-table th {
   cursor: pointer;
 }