Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release next #210

Merged
merged 15 commits into from
Jan 11, 2024
8 changes: 1 addition & 7 deletions _cloud/data-sources/add-data-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,6 @@ Submitting this form will:

The exact SQL being run and its output (including errors) are displayed.

![Add pg data source output]

![Add pg data source output error]

## SQL reference

If you prefer to use SQL for adding data sources, see the following SQL
Expand All @@ -43,9 +39,7 @@ reference:
- [CREATE EXTERNAL TABLE]

[Add data source button]: /assets/images/cloud/data-sources/add-datasource-button.png
[Data sources dialog]: /assets/images/cloud/data-sources/data-sources-dialog.png
[Data sources dialog]: /assets/images/cloud/data-sources/data_sources_dialog.png
[Add pg data source]: /assets/images/cloud/data-sources/add-pg-data-source.png
[Add pg data source output]: /assets/images/cloud/data-sources/add-pg-data-source-output.png
[Add pg data source output error]: /assets/images/cloud/data-sources/add-pg-data-source-output-error.png
[CREATE EXTERNAL DATABASE]: /glaredb/sql-commands/create-external-database/
[CREATE EXTERNAL TABLE]: /glaredb/sql-commands/create-external-table/
4 changes: 2 additions & 2 deletions _cloud/data-sources/query-your-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ for a deployment.
The SQL workspace contains various helpful features for exploring your data,
querying your data and producing basic reports:

- Schema explorer (available from the sidebar)
- Schema explorer and search (available from the sidebar)
- Recent queries (available from the sidebar)
- Completion hints for tables and functions (available in the editor)
- Exporting results (available from the results panel)
Expand Down Expand Up @@ -52,7 +52,7 @@ such as `psql`. For more information on connections strings and passwords, refer
to [Connection Details] and [Managing Passwords].

[Deployment list]: /assets/images/cloud/data-sources/deployments-list.png
[SQL workspace]: /assets/images/cloud/data-sources/sql-workspace.png
[SQL workspace]: /assets/images/cloud/data-sources/sql_workspace.png
[Hybrid Execution]: /glaredb/hybrid-execution
[GlareDB Python library]: /glaredb/python/
[Working with your data]: /docs/working-with-your-data/
Expand Down
6 changes: 3 additions & 3 deletions _glaredb/hybrid-execution.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ is quick and easy.

Once you have a deployment ready to go, open the **Connect** dialog to get a set
of credentials for connecting to your deployment. This dialog provides the
commands needed to connect to your deployment using either the CLI or Python
library.
commands needed to connect to your deployment using either the CLI, Python or
Node.js library.

![Connect dialog]

Expand Down Expand Up @@ -127,6 +127,6 @@ external system.
[Postgres]: /docs/data-sources/supported/postgres.html
[Snowflake]: /docs/data-sources/supported/snowflake.html
[Deployment]: /cloud/deployments/
[Connect dialog]: /assets/images/glaredb/hybrid-execution/connect-dialog.png
[Connect dialog]: /assets/images/glaredb/hybrid-execution/connect_dialog.png
[Python Library]: /glaredb/python/
[CLI]: /glaredb/local/
8 changes: 4 additions & 4 deletions _glaredb/integrations/fabric.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ will automatically be enabled.
[glaredb python library]: https://pypi.org/project/glaredb/
[GlareDB Cloud]: https://console.glaredb.com
[Hybrid Execution]: /glaredb/hybrid-execution/
[create]: /assets/images/fabric/create.png
[cloud]: /assets/images/fabric/cloud.png
[success]: /assets/images/fabric/success.png
[connect]: /assets/images/fabric/connect.png
[create]: /assets/images/glaredb/fabric/create.png
[cloud]: /assets/images/glaredb/fabric/cloud.png
[success]: /assets/images/glaredb/fabric/success.png
[connect]: /assets/images/glaredb/fabric/connect_python.png
2 changes: 1 addition & 1 deletion _glaredb/integrations/hyperquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,5 @@ dataframes can be joined with data in GlareDB Cloud.
[success]: /assets/images/glaredb/hyperquery/success.png
[GlareDB Cloud]: https://console.glaredb.com
[connect button]: /assets/images/glaredb/hyperquery/connect-button.png
[connect python]: /assets/images/glaredb/hyperquery/connect-python.png
[connect python]: /assets/images/glaredb/hyperquery/connect_python.png
[Hybrid Execution]: /glaredb/hybrid-execution/
37 changes: 37 additions & 0 deletions _glaredb/sql-functions/read_clickhouse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
layout: default
title: read_clickhouse
parent: SQL functions
---

# `read_clickhouse`

Read a ClickHouse table. The table does not have to be a known data source to
GlareDB.

## Syntax

```sql
read_clickhouse(<connection_string>, <table>)
```

| Field | Description |
| ------------------- | ------------------------------- |
| `connection_string` | A ClickHouse connection string. |
| `table` | The name of the table to query. |

## Examples

In the following example, a 'users' table located in a ClickHouse database is
queryed.

```sql
select * from read_clickhouse(
'clickhouse://my_user:my_password@my.clickhouse.host:9000/default',
'users'
);
```

Refer to the [documentation on ClickHouse data sources] for more information.

[documentation on ClickHouse data sources]: /docs/data-sources/supported/clickhouse
27 changes: 27 additions & 0 deletions _glaredb/sql-functions/read_excel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
layout: default
title: read_excel
parent: SQL functions
---

# `read_excel`

Reads an Excel file from the local filesystem.

## Syntax

```sql
read_excel(<path>);
```

| Field | Description |
| ------ | ---------------------- |
| `path` | Path to the Excel file |

## Examples

Read an Excel sheet named `sheet.xlsx` located in the current directory.

```sql
SELECT * FROM read_excel('./sheet.xlsx')
```
2 changes: 1 addition & 1 deletion _glaredb/sql-functions/read_postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ In the following example, a 'users' table located in a Postgres database is
queryed.

```sql
select * from read_mysql(
select * from read_postgres(
'host=your.host port=5432 user=postgres password=postgres database=postgres',
'public',
'users'
Expand Down
39 changes: 39 additions & 0 deletions _glaredb/sql-functions/read_sqlserver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: default
title: read_sqlserver
parent: SQL functions
---

# `read_sqlserver`

Read a SQL Server table. The table does not have to be a known data source to
GlareDB.

## Syntax

```sql
read_sqlserver(<connection_string>, <schema>, <table>)
```

| Field | Description |
| ------------------- | -------------------------------------------- |
| `connection_string` | A SQL Server connection string. |
| `schema` | The name of the schema containing the table. |
| `table` | The name of the table to query. |

## Examples

In the following example, a 'users' table located in a SQL Server database is
queryed.

```sql
select * from read_sqlserver(
'server=tcp:my.sqlserver.host,1433;user=SA;password=Password123;TrustServerCertificate=true',
'dbo',
'users'
);
```

Refer to the [documentation on SQL Server data sources] for more information.

[documentation on SQL Server data sources]: /docs/data-sources/supported/sql-server
Binary file removed assets/images/cloud/admin/billing-panel.png
Binary file not shown.
Binary file removed assets/images/cloud/admin/manage-plan.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/images/cloud/data-sources/sql-workspace.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/images/data-sources/ssh-tunnels-sidebar.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/images/fabric/connect.png
Binary file not shown.
Binary file added assets/images/glaredb/fabric/connect_python.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/images/glaredb/hyperquery/connect-python.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/signin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
"words": [
"arrowtypeof",
"BYTEA",
"clickhouse",
"ClickHouse",
"dataframes",
"datasource",
"datasources",
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/securing-connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,6 @@ You can create SSH tunnels from the **SQL workspace**:

![SSH tunnel public key]

[SSH tunnel settings]: /assets/images/data-sources/ssh-tunnels-sidebar.png
[SSH tunnel settings]: /assets/images/data-sources/ssh_tunnels_sidebar.png
[Create SSH tunnel]: /assets/images/data-sources/create_ssh_tunnel.png
[SSH tunnel public key]: /assets/images/data-sources/public-key.png
114 changes: 114 additions & 0 deletions docs/data-sources/supported/clickhouse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
---
layout: default
title: ClickHouse
parent: Supported data sources
grand_parent: "Step 1: Connect your data sources"
---

<!-- markdownlint-disable MD022 -->

<!-- prettier-ignore-start -->
# ClickHouse
{: .no_toc }
<!-- prettier-ignore-end -->

<!-- markdownlint-enable MD022 -->

ClickHouse is able to be used as an external data source. Either an entire
database or a single table may be added as a data source.

<!-- prettier-ignore-start -->

- TOC
{:toc}
<!-- prettier-ignore-end -->

## Connect a ClickHouse database

An entire ClickHouse database can be added using the [CREATE EXTERNAL DATABASE]
command.

{: .important}

### Database

```sql
CREATE EXTERNAL DATABASE <database-name>
FROM clickhouse
OPTIONS (
connection_string = '<connection-string>',
);
```

### Database options

| Field | Description |
| ------------------- | ------------------------------------------------------------------------------ |
| `connection-string` | The connection string to use when connecting to an external ClickHouse server. |

The connection string should be in the form `clickhouse://user:password@hostname:9000/database`.

Once connected, tables can be referenced with the format
`<glaredb-database>.<clickhouse-database>.<table>`.

#### External database example

```sql
-- Create a database with the name 'my_ch'.
CREATE EXTERNAL DATABASE my_ch
FROM clickhouse
OPTIONS (
connection_string = 'clickhouse://my_user:my_password@my.clickhouse.host:9000/default'
);

-- Query a table 'users' in the 'default' ClickHouse database.
SELECT * FROM my_ch.default.users;
```

## Connect a single table

To add an external table, use the [CREATE EXTERNAL TABLE] command. This will add
the table in the current schema.

### Table

```sql
CREATE EXTERNAL TABLE <table-name>
FROM clickhouse
OPTIONS (
connection_string = '<connection-string>',
table = '<table>'
);
```

### Table options

| Field | Description |
| ------------------- | ------------------------------------------------------------------------------ |
| `connection-string` | The connection string to use when connecting to an external ClickHouse server. |
| `table` | The name of the table inside ClickHouse. |

#### External table example

```sql
-- Create a table with the name 'ch_users'
-- backed by a 'users' table in ClickHouse.
CREATE EXTERNAL TABLE ch_users
FROM clickhouse
OPTIONS (
connection_string = 'clickhouse://my_user:my_password@my.clickhouse.host:9000/default',
table = 'users'
);

-- Query a table 'ch_users'.
SELECT * FROM ch_users;
-- Qualified with the GlareDB schema.
SELECT * FROM public.ch_users;
```

<!-- markdownlint-disable line-length -->

[CREATE EXTERNAL TABLE]: /glaredb/sql-commands/create-external-table
[CREATE EXTERNAL DATABASE]: /glaredb/sql-commands/create-external-database

<!-- markdownlint-enable line-length -->
2 changes: 2 additions & 0 deletions docs/releases/2023-december.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ parent: "Release notes"
nav_order: 5
---

# December 2023

## Lance Support

**Available in**: [GlareDB@v0.7.1], [GlareDB Cloud]
Expand Down
39 changes: 39 additions & 0 deletions docs/releases/2024-january.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: default
title: January 2024
parent: "Release notes"
nav_order: 6
---

# January 2024

## ClickHouse

**Available in**: [GlareDB@v0.8.0], [GlareDB Cloud]

GlareDB now supports ClickHouse as an external data source. Learn more in our
[ClickHouse docs](/docs/data-sources/supported/clickhouse).

## Table functions

**Available in**: [GlareDB@v0.8.0], [GlareDB Cloud]

- `read_sqlserver` to read tables from SQL Server:

```sql
select * from read_sqlserver(
'server=tcp:my.sqlserver.host,1433;user=SA;password=Password123;TrustServerCertificate=true',
'dbo',
'users'
);
```

## Misc updates and fixes

**Available in**: [GlareDB@v0.8.0], [GlareDB Cloud]

- Fix reading Iceberg tables with a large version number
([#2281](https://github.com/GlareDB/glaredb/pull/2281))

[GlareDB Cloud]: https://console.glaredb.com
[GlareDB@v0.8.0]: https://github.com/GlareDB/glaredb/releases/tag/v0.8.0
4 changes: 4 additions & 0 deletions docs/releases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ child_nav_order: reversed

GlareDB is open source and contains [full release notes on GitHub].

- [January 2024]
- [ClickHouse](/docs/releases/2024-january.html#clickhouse)
- [Table functions](/docs/releases/2024-january.html#table-functions)
- [December 2023]
- [Lance Support](/docs/releases/2023-november.html#lance-support)
- [Documentation improvements](/docs/releases/2023-november.html#documentation-improvements)
Expand Down Expand Up @@ -44,6 +47,7 @@ GlareDB is open source and contains [full release notes on GitHub].
- [Misc updates and fixes](/docs/releases/2023-august.html#misc-updates-and-fixes)

[full release notes on GitHub]: https://github.com/GlareDB/glaredb/releases
[January 2024]: /docs/releases/2024-january.html#january-2024
[December 2023]: /docs/releases/2023-december.html#december-2023
[November 2023]: /docs/releases/2023-november.html#november-2023
[October 2023]: /docs/releases/2023-october.html#october-2023
Expand Down
Loading