Skip to content

Commit 44e3fcf

Browse files
committed
Better menu
1 parent dae1d07 commit 44e3fcf

File tree

5 files changed

+20
-29
lines changed

5 files changed

+20
-29
lines changed

docs/Keywords.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11

2-
# SQL in AlaSQL
3-
abc
2+
# Keywords in AlaSQL
43

54

6-
## More info
5+
{!wiki/_.md!}
76

8-
def
97

108

119
----

docs/SQL.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
----
22
<a href="http://alasql.org"><img src="https://cloud.githubusercontent.com/assets/1063454/14003947/d6e7b7be-f156-11e5-8a25-71c785031a5f.png" align="right" alt="AlaSQL logo" width="82" height="82"/></a>
33

4-
# SQL in AlaSQL
5-
abc
4+
# AlaSQL seen from a SQL perspective
65

7-
8-
## More info
9-
10-
def
6+
...
117

128

139

docs/index.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,30 @@
66

77
# AlaSQL documentation
88

9-
## Please note this website is only here to test different ways of presenting the yet nonexisting documentation. The site can be edited from https://github.com/AlaSQL/alasql-docs/edit/master/docs/
9+
**Please note this website is only here to test different ways of presenting the yet nonexisting documentation!**
10+
11+
_The site can be edited from https://github.com/AlaSQL/alasql-docs/_
1012

1113
_( [à la](http://en.wiktionary.org/wiki/%C3%A0_la) [SQL](http://en.wikipedia.org/wiki/SQL) ) [ælæ ɛskju:ɛl]_ - AlaSQL is an open source SQL database for Javascript with a strong focus on query speed and datasource flexibility for relational data, schemaless data, and graph data. [Read more about the library in the readme](https://github.com/agershun/alasql/wiki/readme)
1214

1315
Please note that the AlaSQL project is very young and still in active development phase and the API can not be considered 100% stable. Consider this before using the library in production.
1416

1517
All contributions are much welcome and greatly appreciated. The project has never received any funding and is based on unpaid voluntary work: [We really (really) love pull requests](https://github.com/agershun/alasql/blob/develop/CONTRIBUTING.md).
1618

17-
{!https://raw.githubusercontent.com/wiki/agershun/alasql/readme.md!}
18-
123
19-
{!SQL.md!}
20-
2119
## Documentation
2220

23-
This documentation is devided into 4 sections
21+
This documentation is devided into 4 sections:
2422

2523
* Overview (what you are reading right now)
26-
* SQL related
27-
* Javascript related
28-
* Bonus areas
24+
* AlaSQL seen from a SQL point of view
25+
* AlaSQL seen from a javascript point of view
26+
* Documentation of keywords
2927

3028
As AlaSQL merge aspects of Javascript and SQL some features will be mentioned en both sections.
3129

3230

31+
## Short intro
32+
3333
## How to install
3434

3535

@@ -43,12 +43,10 @@ npm install -g alasql # command line
4343
For the browser: include [alasql.min.js](http://cdn.jsdelivr.net/alasql/latest/alasql.min.js)
4444

4545
```html
46-
<script src="http://cdn.jsdelivr.net/alasql/0.2/alasql.min.js"></script>
46+
<script src="http://cdn.jsdelivr.net/alasql/0.3/alasql.min.js"></script>
4747
```
4848

49-
## Short introduction
50-
51-
49+
## How to use
5250

5351

5452
```js
@@ -90,7 +88,7 @@ console.log(res); // [{"a":1,"b":40},{"a":2,"b":20}]
9088

9189
```js
9290
// C) Promise notation + read from file example
93-
alasql.promise('SELECT * FROM XLS("mydata.xls") WHERE lastname LIKE "A%" and city = "London" GROUP BY name ')
91+
alasql(['SELECT * FROM XLS("mydata.xls") WHERE lastname LIKE "A%" and city = "London" GROUP BY name '])
9492
.then(function(res){
9593
console.log(res); // output depends on mydata.xls
9694
}).catch(function(err){
@@ -451,11 +449,10 @@ Warning: Alaserver is not multi-thread, not concurrent, and not secured.
451449
452450
## Limitations
453451
454-
Please be aware that AlaSQL ~~may~~ have [bugs](https://github.com/agershun/alasql/labels/Bug). Besides the bugs there are a number of limitations
452+
Please be aware that AlaSQL ~~may~~ have [bugs](https://github.com/agershun/alasql/labels/Bug). Besides the bugs there are a number of known limitations:
455453
456454
0. AlaSQL has a (long) list of keywords that must be escaped if used for column names. When selecting a field named `key` please write ``` SELECT `key` FROM ... ``` instead. This is also the case for words like ``` `value` ```, ``` `read` ```, ``` `count` ```, ``` `by` ```, ``` `top` ```, ``` `path` ```, ``` `deleted` ```, ``` `work` ``` and ``` `offset` ```. Please consult the [full list of keywords](https://github.com/agershun/alasql/wiki/AlaSQL-Keywords).
457455
458-
459456
0. It is Ok with select for 1000000 records or to join two tables by 10000 records in each (You can use streaming functions to work with longer datasources - see [test/test143.js](test/test143.js)) but be aware that the workload is multiplied so selecting from more than 8 tables with just 100 rows in each will show bad performance. This is one of our top priorities to make better.
460457
461458
0. Limited functionality for transactions (supports only for localStorage) - Sorry, transactions are limited, because AlaSQL started to use more complex approach for PRIMARY KEYS / FOREIGN KEYS. Transactions will be fully turned on again in future version.
File renamed without changes.

mkdocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,6 @@ markdown_extensions:
2424

2525
pages:
2626
- 'Introduction': 'index.md'
27-
- 'SQL': 'SQL.md'
28-
- 'Javasciprt': 'Javascript.md'
29-
- 'Bulk wiki': './wiki/_.md'
27+
- 'Seen fom SQL': 'sql.md'
28+
- 'Seen from Javasciprt': 'js.md'
29+
- 'Keywords': 'keywords.msd'

0 commit comments

Comments
 (0)