Skip to content

Commit

Permalink
Backup of my branch
Browse files Browse the repository at this point in the history
  • Loading branch information
rfraposa committed Sep 21, 2022
1 parent 7304deb commit 69b1d63
Show file tree
Hide file tree
Showing 16 changed files with 166 additions and 80 deletions.
8 changes: 8 additions & 0 deletions copy.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#! /bin/bash

REFERENCE=/Users/richraposa/Documents/repo/ch-non-fork/ClickHouse/docs

cp -R $REFERENCE/en/ docs/en/
cp -R $REFERENCE/ru/ docs/ru/
cp -R $REFERENCE/zh/ docs/zh/

Binary file added docs/en/_snippets/images/createservice1.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 added docs/en/_snippets/images/createservice2.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 added docs/en/_snippets/images/createservice3.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 added docs/en/_snippets/images/createservice4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 12 additions & 4 deletions docs/en/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,18 @@ sidebar_label: Home
sidebar_position: 1
---

# Welcome
# Welcome to ClickHouse

ClickHouse® is a column-oriented database management system (DBMS) for online analytical processing of queries (OLAP).

Home content here

Probably similar to the Help page in the Control Plane
<div class='vimeo-container'>
<iframe src="https://player.vimeo.com/video/751409158?h=54cfbce3b9"
width="640"
height="360"
frameborder="0"
allow="autoplay;
fullscreen;
picture-in-picture"
allowfullscreen>
</iframe>
</div>
30 changes: 30 additions & 0 deletions docs/en/integrations/data-ingestion/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
sidebar_label: Overview
sidebar_position: 1
keywords: [clickhouse, ingest, insert, data, ingestion, insertion]
---

# Getting Data into ClickHouse

<div class='vimeo-container'>
<iframe src="https://player.vimeo.com/video/751409158?h=54cfbce3b9"
width="640"
height="360"
frameborder="0"
allow="autoplay;
fullscreen;
picture-in-picture"
allowfullscreen>
</iframe>
</div>

<br/>

ClickHouse is a database, so there are countless ways to ingest data. There is no special tool designed just for inserting data into ClickHouse. So how do users get data in? Options include:

- simply uploading a CSV file to ClickHouse Cloud as discussed in the [Quick Start](../../quick-start.mdx)
- use [clickhouse-client or clickhouse-local](../clickhouse-client-local.md) to retrieve data from a local file, external file, or some other database like MySQL, PostgreSQL, or any ODBC- or JDBC-compatible database
- write your own client application in your favorite programming language like [Java](../language-clients/jdbc/), [Golang](https://github.com/clickhouse/clickHouse-go#readme) or [Python](https://github.com/clickhouse/clickhouse-connect#readme)
- use one of the technologies listed here in the **Ingest** section of the docs, like [Kafka](./kafka/), [Vector](./vector-to-clickhouse.md), [Airbyte](./airbyte-and-clickhouse.md), and more


85 changes: 71 additions & 14 deletions docs/en/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,85 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';

# Quick Start
# ClickHouse Quick Start

The quickest and easiest way to get up and running with ClickHouse is to create a new
service in [ClickHouse Cloud](https://clickhouse.cloud).

<div class='vimeo-container'>
<iframe src="https://player.vimeo.com/video/751409158?h=54cfbce3b9"
width="640"
height="360"
frameborder="0"
allow="autoplay;
fullscreen;
picture-in-picture"
allowfullscreen>
</iframe>
</div>

ClickHouse runs on ClickHouse Cloud or any Linux, FreeBSD, or macOS system with x86_64, AArch64, or PowerPC64LE CPU architecture. Follow these steps to get up and running with ClickHouse.

## 1. Get ClickHouse

## Step 1. Get ClickHouse

<Tabs groupId="deployMethod">
<TabItem value="serverless" label="ClickHouse Cloud" default>

## Sign in or start a free ClickHouse Cloud trial
To create a free ClickHouse service in [ClickHouse Cloud](https://clickhouse.cloud), you just need to sign up by completing the following steps:

- Create an account on the [sign-up page](https://clickhouse.cloud/signUp)
- Verify your email address (by clicking the link in the email you receive)
- Login using the username and password you just created

Once you are logged in, ClickHouse Cloud starts the onboarding wizard which walks you through creating a new ClickHouse service. Select your
desired region for deploying the service, and give your new service a name:

<div class="eighty-percent">
<img
src={require('./_snippets/images/createservice1.png').default}
alt="New ClickHouse Service"
/>
</div>

<br/>

ClickHouse Cloud uses IP filtering to limit access to your service. Notice your local IP address is already added, and you can add more now or after
after your service is up and running:

<div class="eighty-percent">
<img
src={require('./_snippets/images/createservice2.png').default}
alt="IP Filtering"
/>
</div>

<SignUp/>
<p/>
<br/>

## Create a Service
ClickHouse Cloud generates a password for the `default` user - be sure to save your credentials. (You can always change them later.)

If you are new to ClickHouse Cloud, then welcome! The onboarding experience will walk you through the process of creating a ClickHouse Cloud service, which is an auto-scaling ClickHouse instance that is managed by ClickHouse for you.
<div class="eighty-percent">

If you already have a service, then you can use that existing service for this quick start.
![Download Credentials](./_snippets/images/createservice3.png)

</div>

Your new service will be provisioned and you should see it on your ClickHouse Cloud dashboard:

<div class="eighty-percent">
<img
src={require('./_snippets/images/createservice4.png').default}
alt="Download Credentials"
/>
</div>

<br/>

Congratulations! Your ClickHouse Cloud service is up and running. Keep reading for details on how to connect to it and start ingesting data.

</TabItem>
<TabItem value="selfmanaged" label="Self Managed">
<TabItem value="selfmanaged" label="Self-managed">

ClickHouse runs on ClickHouse Cloud or any Linux, FreeBSD, or macOS system with x86_64, AArch64, or PowerPC64LE CPU architecture. Follow these steps to get up and running with ClickHouse.

:::note
If your OS is not supported or for other install options, view the [installation details in the technical reference guide](/en/getting-started/install/).
Expand Down Expand Up @@ -89,7 +146,7 @@ If your OS is not supported or for other install options, view the [installation
./clickhouse server
```
:::info Important
The examples throughout the documentation use the Linux commands for running the ClickHouse client (`clickhouse-client`).
The examples throughout the documentation use the Linux commands for running the ClickHouse client (`clickhouse-client`).
To run the ClickHouse server and client on a Mac, use `./clickhouse server` and `./clickhouse client`, respectively.
:::

Expand Down Expand Up @@ -121,7 +178,7 @@ You can connect to the SQL console from the Services list in your ClickHouse Clo

![The SQL console](./images/quickstart/SQLConsole.png)

One thing to point out before we get started, ClickHouse takes the security of your data very seriously, and during the creation of your service you were prompted to configure the IP Access List for your service. If you skipped this, or clicked away by mistake, you will not be able to connect to your service.
One thing to point out before we get started, ClickHouse takes the security of your data very seriously, and during the creation of your service you were prompted to configure the IP Access List for your service. If you skipped this, or clicked away by mistake, you will not be able to connect to your service.

Check this by typing `Select 1` in the command section of the SQL Console (the area above the **Run** button) and press **Run**. If the connection is successful, then you will see the response `1` in the result section of the SQL Console. If the connection is not successful you will see the timer spinning and after a few seconds **No response**.

Expand Down Expand Up @@ -183,7 +240,7 @@ If you are unable to connect, then please check the IP Access List for the servi
- Which queries are supported
- Whether or not the data is replicated

There are many engines to choose from, but for a simple table on a single-node ClickHouse server, [MergeTree](/en/engines/table-engines/mergetree-family/mergetree.md) is your likely choice.
There are many engines to choose from, but for a simple table on a single-node ClickHouse server, [MergeTree](/en/engines/table-engines/mergetree-family/mergetree.md) is your likely choice.
:::

### A Brief Intro to Primary Keys
Expand Down Expand Up @@ -304,7 +361,7 @@ You can also connect to your ClickHouse Cloud service using a command-line tool
│ 101 │ Hello, ClickHouse! │ 2022-03-22 14:04:09 │ -1 │
│ 101 │ Granules are the smallest chunks of data read │ 2022-03-22 14:04:14 │ 3.14159 │
└─────────┴────────────────────────────────────────────────────┴─────────────────────┴─────────┘
4 rows in set. Elapsed: 0.008 sec.
```

Expand Down
28 changes: 14 additions & 14 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ const sidebars = {
},
collapsed: false,
items: [
{
{
type: 'doc',
id: 'en/quick-start',
},
{
{
type: 'doc',
id: 'en/tutorial',
},
Expand Down Expand Up @@ -115,8 +115,8 @@ const sidebars = {
type: 'category',
label: 'Ingest',
link: {
type: 'generated-index',
slug: '/en/integrations/data-ingestion',
type: 'doc',
id: 'en/integrations/data-ingestion/index',
},
items: [
{
Expand Down Expand Up @@ -186,7 +186,7 @@ const sidebars = {
type: 'doc',
id: 'en/operations/opentelemetry',
},
]
]
},
{
type: 'category',
Expand Down Expand Up @@ -238,7 +238,7 @@ const sidebars = {
type: 'doc',
id: 'en/guides/sre/scaling-clusters',
},
]
]
},
{
type: 'category',
Expand All @@ -257,7 +257,7 @@ const sidebars = {
type: 'doc',
id: 'en/operations/quotas',
},
]
]
},
{
type: 'category',
Expand Down Expand Up @@ -338,7 +338,7 @@ const sidebars = {
type: 'autogenerated',
dirName: 'en/engines',
}
]
]
},
{
type: 'category',
Expand All @@ -353,7 +353,7 @@ const sidebars = {
},
],
},
]
]
},
{
type: 'category',
Expand Down Expand Up @@ -393,7 +393,7 @@ const sidebars = {
}
]
},
]
]
},
{
type: 'category',
Expand All @@ -409,7 +409,7 @@ const sidebars = {
type: 'autogenerated',
dirName: 'en/interfaces',
}
]
]
},
{
type: 'category',
Expand All @@ -429,10 +429,10 @@ const sidebars = {
type: 'autogenerated',
dirName: 'en/operations/utilities',
}
]
]
},


]
},
{
Expand Down Expand Up @@ -480,7 +480,7 @@ const sidebars = {
}
]
},
],
],
russia: [
{
type: 'autogenerated',
Expand Down
33 changes: 31 additions & 2 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.navbar--fixed-top {
position: fixed;
width: 100%;
}
}

/* give some sace for the breadcrumbs */
.padding-top--md, .padding-vert--md {
Expand Down Expand Up @@ -51,7 +51,7 @@
}

/* this is for the docs homepage, no filter
* and add a background color. set the width
* and add a background color. set the width
* on the images in the row. */
.col--4 img {
filter: none;
Expand Down Expand Up @@ -352,6 +352,12 @@ img {
margin-right: auto;
background: var(--clickhouse-img-background-color);
}
.eighty-percent {
max-width: 80%;
display: block;
margin-left: auto;
margin-right: auto;
}

.col--4 h3 {
font-size: 20px;
Expand Down Expand Up @@ -539,3 +545,26 @@ footer.footer img {

--docusaurus-highlighted-code-line-bg: rgba(255, 255, 255, 0.2);
}

/* Trying to get the Vimeo video to be 100% width and height */
.vimeo-container {
--video--width: 1296;
--video--height: 730;

position: relative;
padding-bottom: calc(var(--video--height) / var(--video--width) * 100%);
overflow: hidden;
max-width: 100%;
background: white;
margin-bottom: 10px;
}

.vimeo-container iframe,
.vimeo-container object,
.vimeo-container embed {
position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;
}
Binary file removed static/img/[email protected]
Binary file not shown.
Binary file removed static/img/[email protected]
Binary file not shown.
Binary file removed static/img/[email protected]
Binary file not shown.
Loading

0 comments on commit 69b1d63

Please sign in to comment.