update readme

Author: Andy Hattemer

README.md

@@ -37,3 +37,14 @@ You'll need to have [docker and docker-compose installed](https://materialize.co
    ```shell session
    psql -h localhost -p 6875 -U materialize -f materialize/create.sql
    ```
+
+5. There is a basic cube schema already drafted for a "Vendors" aggregation in `cube/schema/Vendors.js`
+   a. Test out building a query with it in the Cube.JS Dev Playground at `localhost:4000`
+
+   b. Test curling the query to see how the REST API works
+
+   c. You can test the GraphQL API using the dev playground
+
+   d. Test adding Auth to limit what data each vendor can read.
+
+   e. Try adding a pre-aggregation with a `1 second` cache expiration. This effectively tells Cube Store to cache the view on every query, if Materialize goes down it will continue to serve the last state of the view!

cube/schema/Vendors.js

@@ -2,7 +2,6 @@ cube(`Vendors`, {
   refreshKey: {
     every: `1 second`
   },
-
   sql: `SELECT * FROM public.agg_vendors_minute`,
   measures: {
     count: {
@@ -30,7 +29,7 @@ cube(`Vendors`, {
       type: `number`,
       sql: `SUM(orders)/SUM(pageviews)+1`,
       format: `percent`
-    },
+    }
   },
   dimensions: {
     id: {
@@ -47,4 +46,13 @@ cube(`Vendors`, {
     }
   },
   dataSource: `default`,
-});
+  preAggregations: {
+    main: {
+      measures: [Vendors.totalRevenue, Vendors.totalOrders, Vendors.totalPageviews, Vendors.totalItemsSold],
+      dimensions: [Vendors.name, Vendors.id, Vendors.receivedAtMinute],
+      refreshKey: {
+        every: `1 day`,
+      }
+    }
+  }
+});

materialize/create.sql

@@ -53,7 +53,7 @@ CREATE MATERIALIZED VIEW agg_vendors_minute AS
     SELECT
         vendors.id as vendor_id,
         vendors.name as vendor_name,
-        minute_series.m,
+        minute_series.m::timestamp,
         SUM(purchases.quantity) as items_sold,
         COUNT(purchases.id) as orders,
         SUM(purchases.purchase_price) as revenue,

materialize/drop.sql

@@ -1,4 +1,5 @@
 DROP SOURCE purchases CASCADE;
 DROP SOURCE items CASCADE;
 DROP SOURCE users CASCADE;
+DROP SOURCE vendors CASCADE;
 DROP SOURCE json_pageviews CASCADE;