|
1 | | -<h1 align="center">Developer Documentation</h1> |
| 1 | +<h1 align="center">exasol/developer-documentation</h1> |
2 | 2 |
|
3 | 3 | <p align="center"> |
4 | | -Documentation and resources for data scientists and programmatic users to perform analytics with Exasol and to build applications on top. |
| 4 | +Documentation and resources for developing software and data science solutions and applications on top of the Exasol Analytics Engine. |
5 | 5 | </p> |
6 | 6 |
|
7 | | - |
8 | | -# Getting Started |
9 | | -There are three ways to get started with Exasol: |
10 | | -- Download the [community edition](https://www.exasol.com/free-signup-community-edition/) |
11 | | -- Use the [docker version](https://github.com/exasol/docker-db) |
12 | | -- Signup for a free [SaaS trial](https://cloud.exasol.com/signup) |
13 | | - |
14 | | -In the following we are going to use the SaaS version. |
15 | | - |
16 | | -## Setting up the db |
17 | | -Our [main documentation](https://docs.exasol.com/saas/get_started/saas_first_steps.htm) shows you how to create a SaaS account and setup your first database and cluster. |
18 | | -## Installing pyexasol |
19 | | -Once your database is up and running you can connect via any client. From Python we use [PyExasol](https://github.com/exasol/pyexasol). |
20 | | -It can be easily installed via |
21 | | -``` |
22 | | -pip install pyexasol[pandas] |
23 | | -``` |
24 | | - |
25 | | -## Connecting to the db |
26 | | -Connecting to an Exasol database is performed via: |
27 | | -```python |
28 | | -import pyexasol |
29 | | - |
30 | | -C = pyexasol.connect(dsn='<host:port>', user='sys', password='exasol') |
31 | | -``` |
32 | | -It is slightly different when connecting to a SaaS database as we need a [personal access token](https://docs.exasol.com/saas/administration/access_mngt/access_token.htm): |
33 | | -```python |
34 | | -import pyexasol |
35 | | - |
36 | | -C = pyexasol.connect(dsn='<host:port>', user='sys', password='<token>') |
37 | | -``` |
38 | | -Finally you can also wrap all credentials into a [local config file](https://exasol.github.io/pyexasol/master/user_guide/local_config.html): |
39 | | -```python |
40 | | -C = pyexasol.connect_local_config('my_exasol') |
41 | | -``` |
42 | | -## Executing SQL |
43 | | -Running your first query is pretty straightforward: |
44 | | -```python |
45 | | -stmt = C.execute("SELECT * FROM EXA_ALL_USERS") |
46 | | - |
47 | | -for row in stmt: |
48 | | - print(row) |
49 | | -``` |
50 | | -It also allows you to load resultsets into a pandas dataframe: |
51 | | -```python |
52 | | -C = pyexasol.connect(dsn='<host:port>', user='sys', password='exasol', compression=True) |
53 | | - |
54 | | -df = C.export_to_pandas("SELECT * FROM EXA_ALL_USERS") |
55 | | -print(df.head()) |
56 | | -``` |
57 | | - |
58 | | - |
59 | | -# Data Ingestion |
60 | | -## CSV Files |
61 | | -## Parquet Files |
62 | | -## Import from external sources |
63 | | -## HTTP Transport |
64 | | -# Distributed Python (UDFs) |
65 | | -## Intro to UDFs |
66 | | -## Creating and running UDFs |
67 | | -## Debugging UDFs |
68 | | -# Advanced |
69 | | -## move all the other stuff here |
70 | | -# Examples |
71 | | -# Environments |
72 | | -## Jupyter Notebooks |
73 | | -## VSCode |
74 | | -## Positron |
75 | | -# Integrations |
76 | | -## JupySQL |
77 | | -## Pandas |
78 | | -## Ibis |
79 | | -## SQLAlchemy |
| 7 | +Checkout the latest [documentation](https://exasol.github.io/developer-documentation/). |
0 commit comments