Skip to content

Commit

Permalink
Update documentation for 3.4
Browse files Browse the repository at this point in the history
  • Loading branch information
pixelspark committed Sep 11, 2016
1 parent 92960af commit 82101b0
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 17 deletions.
6 changes: 4 additions & 2 deletions Docs/docs/knownissues.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ Warp by default tries to connect to a database called 'test' when connecting to

# [#2] Warp won't be able to write to certain SQLite databases due to sandboxing restrictions

**Affects:** all versions
**Affects:** all versions, **Resolved in:** version 3.5

Due to sandboxing restrictions, Warp is not always able to write to SQLite databases that use journaling. Sandboxing requires Warp to obtain special permissions to write to SQLite journal files, but in some cases is unable to obtain these permissions.

** Workaround**: Disable journaling for the databases, or try to re-open the database using the 'Load data from file' command from the 'File' menu in Warp. You may also contact us to obtain a copy of Warp that runs outside the sandbox.
In version 3.4, SQLite databases that use journaling may in some cases not open at all.

** Workaround**: Disable journaling for the databases (open the file using the SQLite3 command line tool or another application, and perform the following query: `PRAGMA journal_mode=DELETE;`). You may also contact us to obtain a copy of Warp that runs outside the sandbox.
15 changes: 4 additions & 11 deletions Docs/docs/pack.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,7 @@ In Warp, you can use the 'PACK' function to create a pack:

## Extracting values from a pack

In Warp, you can use the 'NTH' function to extract data from a pack. The NTH funtion takes a pack string as its first argument, and an index as its second argument. It will return the value at the specified index in the pack, or return an invalid value if that index does not exist.

````
=NTH("foo,bar,baz"; 1) will return "foo"
````

The shorthand notation for calling NTH(a;b) is simply a[b]:
In Warp, you can use square brackets to extract data from a pack. This will return the value at the specified index in the pack, or return an invalid value if that index does not exist.

````
="foo,bar,baz"[2] will return "bar"
Expand All @@ -39,11 +33,10 @@ Packs can also be used to store key-value pairs: simply alternate the keys and v
first_name,Tommy,last_name,van der Vorst
````

You can use 'NTH' to extract values:
You can use the 'arrow' syntax to extract values:

````
=NTH("first_name,Tommy,last_name,van der Vorst"; "first_name") will return "Tommy"
="first_name,Tommy,last_name,van der Vorst"["first_name"] will return "Tommy"
="first_name,Tommy,last_name,van der Vorst"->"first_name" will return "Tommy"
````

## JSON
Expand All @@ -63,5 +56,5 @@ baz,deepSpace$09,foo,bar
Reading fields from this pack is simple:

````
=FROM.JSON("{""foo"":""bar"", ""baz"":{""deepSpace"": 9}}")["baz"]["deepSpace"] will return 9
=FROM.JSON("{""foo"":""bar"", ""baz"":{""deepSpace"": 9}}")->"baz"->"deepSpace" will return 9
````
9 changes: 5 additions & 4 deletions Docs/docs/whatsnew.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Version 3.4

Released: tbd.
Released: September 12, 2016

* You can now more easily extract values from JSON-formatted data. Simply select a JSON value and go to 'Value' -> 'Extract data from JSON'. This will present a visual representation of the JSON data and allows you to select the data to be extracted.
* The formula editor now shows available columns and an example of the formula result
* You can now easily add data sets that are related to a data set (e.g. tables that have a foreign key relationship). To do so drag an arrow out from the table and select the menu item 'related data sets'.
* You can now use the a[b] syntax to access pack items (shorthand syntax for NTH(a;b))
* When you ask Warp to calculate the full result of a calculation, Warp will now stream in the results
* You can now download data from URLs using the 'download data from the web' step
* You can now use the a[b] syntax to access pack items (where b is a numeric value; this is shorthand syntax for NTH(a;b)). You can use the a->"b" syntax to access a value from a map.
* When you ask Warp to calculate the full result of a calculation, Warp will now stream in the results.
* You can now download data from URLs using the 'download data from the web' step.
* You can now split lists to multiple rows and to multiple columns using the corresponding steps available in the 'Rows' and 'Columns' menu respectively.
* You can now ask Warp to cache data from 'slow' data sources in-memory, so you can work with them more quickly. To do so, go to the 'Table' menu and select 'Cache data'. Remember to click 'Clear cache' to re-load the cache with the latest version of the data, if the source data changes.

Expand Down

0 comments on commit 82101b0

Please sign in to comment.