dataframe-js/doc/api/modules/sql.md

Immutable and functional data structure for datascientists and developpers

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

-   [SQL][1]
    -   [Parameters][2]
    -   [register][3]
        -   [Parameters][4]
        -   [Examples][5]
    -   [request][6]
        -   [Parameters][7]
        -   [Examples][8]
    -   [dropTables][9]
        -   [Examples][10]
    -   [dropTable][11]
        -   [Parameters][12]
        -   [Examples][13]
    -   [renameTable][14]
        -   [Parameters][15]
        -   [Examples][16]
    -   [listTables][17]
        -   [Examples][18]
    -   [registerTable][19]
        -   [Parameters][20]
        -   [Examples][21]

## SQL

[src/modules/sql/index.js:12-109][22]

SQL module for DataFrame, providing SQL-like syntax for data exploration in DataFrames.

### Parameters

-   `df` **DataFrame** An instance of DataFrame.

### register

[src/modules/sql/index.js:105-108][23]

Register the DataFrame as temporary table.

#### Parameters

-   `tableName` **[String][24]** The name of the table.
-   `overwrite` **[Boolean][25]** Overwrite if the table already exists. (optional, default `false`)

#### Examples

```javascript
df.sql.register('tmp');
```

### request

[src/modules/sql/index.js:20-24][26]

Request on a SQL query.

#### Parameters

-   `query` **[String][24]** A SQL query to request.

#### Examples

```javascript
DataFrame.request('SELECT * FROM tmp');
```

Returns **any** The result of the query.

### dropTables

[src/modules/sql/index.js:31-33][27]

Drop or remove all registered tables.

#### Examples

```javascript
DataFrame.dropTables();
```

### dropTable

[src/modules/sql/index.js:41-43][28]

Drop or remove a registered table.

#### Parameters

-   `tableName` **[String][24]** The registered table to drop.

#### Examples

```javascript
DataFrame.dropTable('tmp1');
```

### renameTable

[src/modules/sql/index.js:53-56][29]

Rename a registered table.

#### Parameters

-   `tableName` **[String][24]** The registered table to rename.
-   `replacement` **[String][24]** The new table name.
-   `overwrite` **[Boolean][25]** Overwrite if the table already exists. (optional, default `false`)

#### Examples

```javascript
DataFrame.renameTable('tmp1', 'notTmp1');
```

### listTables

[src/modules/sql/index.js:64-66][30]

List all registered tables.

#### Examples

```javascript
DataFrame.listTables();
```

Returns **[Array][31]** A list of the registered tables.

### registerTable

[src/modules/sql/index.js:76-87][32]

Register a DataFrame as a temporary table.

#### Parameters

-   `df` **DataFrame** The DataFrame to register.
-   `tableName` **[String][24]** The temporary table name.
-   `overwrite` **[Boolean][25]** Overwrite if the table already exists. (optional, default `false`)

#### Examples

```javascript
DataFrame.registerTable('tmp', df);
```

[1]: #sql

[2]: #parameters

[3]: #register

[4]: #parameters-1

[5]: #examples

[6]: #request

[7]: #parameters-2

[8]: #examples-1

[9]: #droptables

[10]: #examples-2

[11]: #droptable

[12]: #parameters-3

[13]: #examples-3

[14]: #renametable

[15]: #parameters-4

[16]: #examples-4

[17]: #listtables

[18]: #examples-5

[19]: #registertable

[20]: #parameters-5

[21]: #examples-6

[22]: https://github.com/Gmousse/dataframe-js/blob/add47391719e84537fdc30c80f762b3a8b38ba9a/src/modules/sql/index.js#L12-L109 "Source code on GitHub"

[23]: https://github.com/Gmousse/dataframe-js/blob/add47391719e84537fdc30c80f762b3a8b38ba9a/src/modules/sql/index.js#L105-L108 "Source code on GitHub"

[24]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

[25]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean

[26]: https://github.com/Gmousse/dataframe-js/blob/add47391719e84537fdc30c80f762b3a8b38ba9a/src/modules/sql/index.js#L20-L24 "Source code on GitHub"

[27]: https://github.com/Gmousse/dataframe-js/blob/add47391719e84537fdc30c80f762b3a8b38ba9a/src/modules/sql/index.js#L31-L33 "Source code on GitHub"

[28]: https://github.com/Gmousse/dataframe-js/blob/add47391719e84537fdc30c80f762b3a8b38ba9a/src/modules/sql/index.js#L41-L43 "Source code on GitHub"

[29]: https://github.com/Gmousse/dataframe-js/blob/add47391719e84537fdc30c80f762b3a8b38ba9a/src/modules/sql/index.js#L53-L56 "Source code on GitHub"

[30]: https://github.com/Gmousse/dataframe-js/blob/add47391719e84537fdc30c80f762b3a8b38ba9a/src/modules/sql/index.js#L64-L66 "Source code on GitHub"

[31]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array

[32]: https://github.com/Gmousse/dataframe-js/blob/add47391719e84537fdc30c80f762b3a8b38ba9a/src/modules/sql/index.js#L76-L87 "Source code on GitHub"