Skip to content

Commit 6ba3ef8

Browse files
committed
add some docs
1 parent 7f8e0fa commit 6ba3ef8

File tree

3 files changed

+41
-2
lines changed

3 files changed

+41
-2
lines changed

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,42 @@
1-
# Excel client for Materialize using ExcelDNA
1+
# Excel client for Materialize using System.Reactive and Excel-DNA
22

3+
[Materialize](https://materialize.com/) is an awesome streaming SQL database.
4+
5+
Excel is... better at displaying real-time data than many people realize.
6+
7+
This add-in provides a single UDF `=MZ_TAIL(query)` where query is an object (source, table, view) name or select statement.
8+
9+
![MZ_TAIL usage](doc/mz_tail.gif?raw=true "MZ_TAIL")
10+
11+
There is also a custom task pane which displays the data catalog from the Materialize server.
12+
13+
![custom task page](doc/mz_task_pane.gif?raw=true "Custom task pane")
14+
15+
## Installation
16+
17+
Download the release or build the solution yourself (artifacts will be in `MaterializeExcel.AddIn\bin\Debug`).
18+
19+
Edit the `.config` file for your Materialize host.
20+
```
21+
<MaterializeExcel.AddIn.Properties.Settings>
22+
<setting name="Host" serializeAs="String">
23+
<value>localhost</value>
24+
</setting>
25+
<setting name="Port" serializeAs="String">
26+
<value>6875</value>
27+
</setting>
28+
<setting name="Database" serializeAs="String">
29+
<value>materialize</value>
30+
</setting>
31+
<setting name="User" serializeAs="String">
32+
<value>materialize</value>
33+
</setting>
34+
</MaterializeExcel.AddIn.Properties.Settings>
35+
```
36+
37+
Follow the [Add or remove an Excel add-in](https://support.microsoft.com/en-us/office/add-or-remove-add-ins-in-excel-0af570c4-5cf3-4fa9-9b88-403625a0b460) instructions from Microsoft. Make sure the `.xll` and `.config` files stay together.
38+
39+
Note - Excel will complain about this being an unsigned/untrusted add-in. Read and build the code yourself if you prefer.
340

441
## Materialize demo set up
542

@@ -13,4 +50,6 @@ Only works with native Excel 365 on Windows.
1350

1451
Order by clauses are not implemented.
1552

16-
Large grids are currently inefficient due to copy from multiset to 2d array.
53+
Large grids are currently inefficient due to copy from multiset to 2d array.
54+
55+
Only simple username login is implemented.

doc/mz_tail.gif

636 KB
Loading

doc/mz_task_pane.gif

852 KB
Loading

0 commit comments

Comments
 (0)