Merge branch 'main' into vldb_paper

Author: Blargian

docs/_snippets/_S3_authentication_and_bucket.md

@@ -1,3 +1,20 @@
+import s3_1 from '@site/static/images/_snippets/s3/s3-1.png';
+import s3_2 from '@site/static/images/_snippets/s3/s3-2.png';
+import s3_3 from '@site/static/images/_snippets/s3/s3-3.png';
+import s3_4 from '@site/static/images/_snippets/s3/s3-4.png';
+import s3_5 from '@site/static/images/_snippets/s3/s3-5.png';
+import s3_6 from '@site/static/images/_snippets/s3/s3-6.png';
+import s3_7 from '@site/static/images/_snippets/s3/s3-7.png';
+import s3_8 from '@site/static/images/_snippets/s3/s3-8.png';
+import s3_9 from '@site/static/images/_snippets/s3/s3-9.png';
+import s3_a from '@site/static/images/_snippets/s3/s3-a.png';
+import s3_b from '@site/static/images/_snippets/s3/s3-b.png';
+import s3_c from '@site/static/images/_snippets/s3/s3-c.png';
+import s3_d from '@site/static/images/_snippets/s3/s3-d.png';
+import s3_e from '@site/static/images/_snippets/s3/s3-e.png';
+import s3_f from '@site/static/images/_snippets/s3/s3-f.png';
+import s3_g from '@site/static/images/_snippets/s3/s3-g.png';
+import s3_h from '@site/static/images/_snippets/s3/s3-h.png';
 
 <details>
   <summary>Create S3 buckets and an IAM user</summary>
@@ -10,85 +27,85 @@ In this procedure, we'll be creating a service account user, not a login user.
 
 2. In "users", select **Add users**
 
-  ![create_iam_user_0](@site/docs/_snippets/images/s3/s3-1.png)
+<img src={s3_1} alt="create_iam_user_0"/>
 
 3. Enter the user name and set the credential type to **Access key - Programmatic access** and select **Next: Permissions**
 
-  ![create_iam_user_1](@site/docs/_snippets/images/s3/s3-2.png)
+<img src={s3_2} alt="create_iam_user_1"/>
 
 4. Do not add the user to any group; select **Next: Tags**
 
-  ![create_iam_user_2](@site/docs/_snippets/images/s3/s3-3.png)
+<img src={s3_3} alt="create_iam_user_2"/>
 
 5. Unless you need to add any tags, select **Next: Review**
 
-  ![create_iam_user_3](@site/docs/_snippets/images/s3/s3-4.png)
+<img src={s3_4} alt="create_iam_user_3"/>
 
 6. Select **Create User**
 
     :::note
     The warning message stating that the user has no permissions can be ignored; permissions will be granted on the bucket for the user in the next section
     :::
 
-  ![create_iam_user_4](@site/docs/_snippets/images/s3/s3-5.png)
+<img src={s3_5} alt="create_iam_user_4"/>
 
 7. The user is now created; click on **show** and copy the access and secret keys.
 :::note
 Save the keys somewhere else; this is the only time that the secret access key will be available.
 :::
 
-  ![create_iam_user_5](@site/docs/_snippets/images/s3/s3-6.png)
+<img src={s3_6} alt="create_iam_user_5"/>
 
 8. Click close, then find the user in the users screen.
 
-  ![create_iam_user_6](@site/docs/_snippets/images/s3/s3-7.png)
+<img src={s3_7} alt="create_iam_user_6"/>
 
 9. Copy the ARN (Amazon Resource Name) and save it for use when configuring the access policy for the bucket.
 
-  ![create_iam_user_7](@site/docs/_snippets/images/s3/s3-8.png)
+<img src={s3_8} alt="create_iam_user_7"/>
 
 ### Create an S3 bucket {#create-an-s3-bucket}
 1. In the S3 bucket section, select **Create bucket**
 
-  ![create_s3_bucket_0](@site/docs/_snippets/images/s3/s3-9.png)
+<img src={s3_9} alt="create_s3_bucket_0"/>
 
 2. Enter a bucket name, leave other options default
 :::note
 The bucket name must be unique across AWS, not just the organization, or it will emit an error.
 :::
 3. Leave `Block all Public Access` enabled; public access is not needed.
 
-  ![create_s3_bucket_2](@site/docs/_snippets/images/s3/s3-a.png)
+<img src={s3_a} alt="create_s3_bucket_2"/>
 
 4. Select **Create Bucket** at the bottom of the page
 
-  ![create_s3_bucket_3](@site/docs/_snippets/images/s3/s3-b.png)
+<img src={s3_b} alt="create_s3_bucket_3"/>
 
 5. Select the link, copy the ARN, and save it for use when configuring the access policy for the bucket.
 
 6. Once the bucket has been created, find the new S3 bucket in the S3 buckets list and select the link
 
-  ![create_s3_bucket_4](@site/docs/_snippets/images/s3/s3-c.png)
+<img src={s3_c} alt="create_s3_bucket_4"/>
 
 7. Select **Create folder**
 
-  ![create_s3_bucket_5](@site/docs/_snippets/images/s3/s3-d.png)
+<img src={s3_d} alt="create_s3_bucket_5"/>
 
 8. Enter a folder name that will be the target for the ClickHouse S3 disk and select **Create folder**
 
-  ![create_s3_bucket_6](@site/docs/_snippets/images/s3/s3-e.png)
+<img src={s3_e} alt="create_s3_bucket_6"/>
 
 9. The folder should now be visible on the bucket list
 
-  ![create_s3_bucket_7](@site/docs/_snippets/images/s3/s3-f.png)
+<img src={s3_f} alt="create_s3_bucket_7"/>
 
 10. Select the checkbox for the new folder and click on **Copy URL** Save the URL copied to be used in the ClickHouse storage configuration in the next section.
 
-  ![create_s3_bucket_8](@site/docs/_snippets/images/s3/s3-g.png)
+<img src={s3_g} alt="create_s3_bucket_8"/>
 
 11. Select the **Permissions** tab and click on the **Edit** button in the **Bucket Policy** section
 
-  ![create_s3_bucket_9](@site/docs/_snippets/images/s3/s3-h.png)
+<img src={s3_h} alt="create_s3_bucket_9"/>
 
 12. Add a bucket policy, example below:
 ```json

docs/chdb/guides/index.md

@@ -13,3 +13,12 @@ from YAML frontmatter fields title, slug, description. If you've found an error
 in the table of contents, please edit the frontmatter of the files directly.
 -->
 
+| Page | Description |
+|-----|-----|
+| [How to query Parquet files](/docs/chdb/guides/querying-parquet) | Learn how to query Parquet files with chDB. |
+| [How to query data in an S3 bucket](/docs/chdb/guides/querying-s3) | Learn how to query data in an S3 bucket with chDB. |
+| [Using a clickhouse-local database](/docs/chdb/guides/clickhouse-local) | Learn how to use a clickhouse-local database with chDB |
+| [How to query Pandas DataFrames with chDB](/docs/chdb/guides/pandas) | Learn how to query Pandas DataFrames with chDB |
+| [JupySQL and chDB](/docs/chdb/guides/jupysql) | How to install chDB for Bun |
+| [How to query a remote ClickHouse server](/docs/chdb/guides/query-remote-clickhouse) | In this guide, we'll learn how to query a remote ClickHouse server from chDB. |
+| [How to query Apache Arrow with chDB](/docs/chdb/guides/apache-arrow) | In this guide, we'll learn how to query Apache Arrow tables with chDB |

docs/cloud/get-started/query-endpoints.md

@@ -5,6 +5,13 @@ description: Easily spin up REST API endpoints from your saved queries
 keywords: [api, query api endpoints, query endpoints, query rest api]
 ---
 
+import endpoints_testquery from '@site/static/images/cloud/sqlconsole/endpoints-testquery.png';
+import endpoints_savequery from '@site/static/images/cloud/sqlconsole/endpoints-savequery.png';
+import endpoints_configure from '@site/static/images/cloud/sqlconsole/endpoints-configure.png';
+import endpoints_completed from '@site/static/images/cloud/sqlconsole/endpoints-completed.png';
+import endpoints_curltest from '@site/static/images/cloud/sqlconsole/endpoints-curltest.png';
+import endpoints_monitoring from '@site/static/images/cloud/sqlconsole/endpoints-monitoring.png';
+
 # Query API Endpoints
 
 The **Query API Endpoints** feature allows you to create an API endpoint directly from any saved SQL query in the ClickHouse Cloud console. You'll be able to access API endpoints via HTTP to execute your saved queries without needing to connect to your ClickHouse Cloud service via a native driver.
@@ -38,23 +45,23 @@ limit 10
 
 Note that this query contains a parameter (`year`). The SQL console query editor automatically detects ClickHouse query parameter expressions and provides an input for each parameter. Let's quickly run this query to make sure that it works:
 
-![Test the example query](@site/docs/cloud/images/sqlconsole/endpoints-testquery.png)
+<img src={endpoints_testquery} alt="Test the example query"/>
 
 Next step, we'll go ahead and save the query:
 
-![Save example query](@site/docs/cloud/images/sqlconsole/endpoints-savequery.png)
+<img src={endpoints_savequery} alt="Save example query"/>
 
 More documentation around saved queries can be found [here](/cloud/get-started/sql-console#saving-a-query).
 
 ### Configuring the Query API Endpoint {#configuring-the-query-api-endpoint}
 
 Query API endpoints can be configured directly from query view by clicking the **Share** button and selecting `API Endpoint`. You'll be prompted to specify which API key(s) should be able to access the endpoint:
 
-![Configure query endpoint](@site/docs/cloud/images/sqlconsole/endpoints-configure.png)
+<img src={endpoints_configure} alt="Configure query endpoint"/>
 
 After selecting an API key, the query API endpoint will automatically be provisioned. An example `curl` command will be displayed so you can send a test request:
 
-![Endpoint curl command](@site/docs/cloud/images/sqlconsole/endpoints-completed.png)
+<img src={endpoints_completed} alt="Endpoint curl command"/>
 
 ### Query API parameters {#query-api-parameters}
 
@@ -63,11 +70,14 @@ Query parameters in a query can be specified with the syntax `{parameter_name: t
 ### Testing and monitoring {#testing-and-monitoring}
 
 Once a Query API endpoint is created, you can test that it works by using `curl` or any other HTTP client:
-<img src={require('@site/docs/cloud/images/sqlconsole/endpoints-curltest.png').default} class="image" alt="endpoint curl test" style={{width: '80%', background:'none'}} />
+
+
+<img src={endpoints_curltest} class="image" alt="endpoint curl test" style={{width: '80%', background:'none'}} />
 
 After you've sent your first request, a new button should appear immediately to the right of the **Share** button. Clicking it will open a flyout containing monitoring data about the query:
 
-![Endpoint monitoring](@site/docs/cloud/images/sqlconsole/endpoints-monitoring.png)
+<img src={endpoints_monitoring} alt="Endpoint monitoring"/>
+
 
 ## Implementation Details {#implementation-details}
 

docs/cloud/get-started/query-insights.md

@@ -5,6 +5,12 @@ description: Visualize system.query_log data to simplify query debugging and per
 keywords: [query insights, query log, query log ui, system.query_log insights]
 ---
 
+import insights_overview from '@site/static/images/cloud/sqlconsole/insights_overview.png';
+import insights_latency from '@site/static/images/cloud/sqlconsole/insights_latency.png';
+import insights_recent from '@site/static/images/cloud/sqlconsole/insights_recent.png';
+import insights_drilldown from '@site/static/images/cloud/sqlconsole/insights_drilldown.png';
+import insights_query_info from '@site/static/images/cloud/sqlconsole/insights_query_info.png';
+
 # Query Insights
 
 The **Query Insights** feature makes ClickHouse's built-in query log easier to use through various visualizations and tables. ClickHouse's `system.query_log` table is a key source of information for query optimization, debugging, and monitoring overall cluster health and performance.
@@ -13,31 +19,31 @@ The **Query Insights** feature makes ClickHouse's built-in query log easier to u
 
 After selecting a service, the **Monitoring** navigation item in the left sidebar should expand to reveal a new **Query insights** sub-item. Clicking on this option opens the new Query insights page:
 
-![Query Insights UI Overview](@site/docs/cloud/images/sqlconsole/insights_overview.png)
+<img src={insights_overview} alt="Query Insights UI Overview"/>
 
 ## Top-level metrics {#top-level-metrics}
 
 The stat boxes at the top represent some basic top-level query metrics over the selected period of time. Beneath it, we’ve exposed three time-series charts representing query volume, latency, and error rate broken down by query kind (select, insert, other) over a selected time window. The latency chart can be further adjusted to display p50, p90, and p99 latencies:
 
-![Query Insights UI Latency Chart](@site/docs/cloud/images/sqlconsole/insights_latency.png)
+<img src={insights_latency} alt="Query Insights UI Latency Chart"/>
 
 ## Recent queries {#recent-queries}
 
 Beneath the top-level metrics, a table displays query log entries (grouped by normalized query hash and user) over the selected time window:
 
-![Query Insights UI Recent Queries Table](@site/docs/cloud/images/sqlconsole/insights_recent.png)
+<img src={insights_recent} alt="Query Insights UI Recent Queries Table"/>
 
 Recent queries can be filtered and sorted by any available field. The table can also be configured to display or hide additional fields such as tables, p90, and p99 latencies.
 
 ## Query drill-down {#query-drill-down}
 
 Selecting a query from the recent queries table will open a flyout containing metrics and information specific to the selected query:
 
-![Query Insights UI Query Drill down](@site/docs/cloud/images/sqlconsole/insights_drilldown.png)
+<img src={insights_drilldown} alt="Query Insights UI Query Drill down"/>
 
 As we can see from the flyout, this particular query has been run more than 3000 times in the last 24 hours. All metrics in the **Query info** tab are aggregated metrics, but we can also view metrics from individual runs by selecting the **Query history** tab:
 
-<img src={require('@site/docs/cloud/images/sqlconsole/insights_query_info.png').default}    
+<img src={insights_query_info}    
   class="image"
   alt="Query Insights UI Query Information"
   style={{width: '400px'}} />