mirrors/dozzle
1
0
Fork 0
mirror of https://github.com/amir20/dozzle.git synced 2025-12-24 06:28:42 +01:00
Code Issues Projects Releases Wiki Activity

docs: fixes grammar and spelling errors (#3413)

Browse Source
This commit is contained in:
Amir Raminfar
2024-11-20 09:41:58 -08:00
committed by GitHub
parent 9d244cf26b
commit 4c1f5b4062
17 changed files with 99 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/guide/sql-engine.md
View File

@@ -10,11 +10,11 @@ This feature is currently in beta and is available to all users. If you have any
## Getting Started
To get started with the SQL Engine, you will need to have a dataset that you can query. Only JSON logs can be queried using SQL. Dozzle leveages the power of WebAssembly to run SQL queries in the browser, which means that your data never leaves your machine.
To get started with the SQL Engine, you will need to have a dataset that you can query. Only JSON logs can be queried using SQL. Dozzle leverages the power of WebAssembly to run SQL queries in the browser, which means that your data never leaves your machine.
To start using the SQL Engine, make sure you have JSON logs and naviage to the drop down and choose `SQL Analytics`. There is also a keyboard shortcut `^+⇧+f` or `⌘+⇧+f` to quickly open the SQL Engine.
To start using the SQL Engine, make sure you have JSON logs and navigate to the dropdown and choose `SQL Analytics`. There is also a keyboard shortcut `^+⇧+f` or `⌘+⇧+f` to quickly open the SQL Engine.
## How does it work?
## How Does It Work?
The SQL Engine uses WebAssembly to run SQL queries in the browser with DuckDB. When the SQL Engine is first opened, DuckDB WASM is downloaded and initialized in the browser. This could take a while if you are on a slow connection. The SQL Engine then reads _only_ the JSON logs and creates a virtual table in DuckDB. This allows you to run SQL queries against your data in real-time.
@@ -52,6 +52,6 @@ SELECT level, COUNT(*) FROM logs GROUP BY level
WebAssembly has some limitations that you should be aware of when using the SQL Engine:
- The SQL Engine only supports structured data such as JSON.
- The SQL Engine is limited to running queries in the browser. This means that you cannot run queries that require access to external resources or databases.
- There is a maximum of 4GB of memory that can be used by the SQL Engine. If you run out of memory, you will need to refresh the page to clear the memory.
- The SQL Engine only supports structured data such as JSON
- The SQL Engine is limited to running queries in the browser. This means that you cannot run queries that require access to external resources or databases
- There is a maximum of 4GB of memory that can be used by the SQL Engine. If you run out of memory, you will need to refresh the page to clear the memory