SQLPage

https://sql-page.com/documentation
Admin
SQLPage is a framework that enables developers to build web applications by writing SQL queries,...
Tokens:2,159
Snippets:21
Trust Score:8.1
Update:11 months ago
Show doc for...
Tokens:
Raw
### SQLPage: Select Component and Top-Level Parameters

Source: https://sql-page.com/documentation/.sql

This snippet demonstrates how to select a component and set its top-level properties in SQLPage. It defines the component name and its associated parameters for customization.

```sql
SELECT 'component_name' AS component, 'my value' AS top_level_parameter_1;
```

--------------------------------

### Download File with Data URL - SQLPage

Source: https://sql-page.com/documentation/.sql

The download component allows a page to immediately return a file to the visitor. It takes a data URL as input, which contains the file type and data, and an optional filename. This component should be placed at the top of the SQL page.

```sqlpage
-- Example with plain text
SELECT sqlpage.download_file_as_data_url('data:text/plain,Hello%20world', 'hello.txt');

-- Example with JSON
SELECT sqlpage.download_file_as_data_url('data:application/json,%7B%22message%22%3A%22Hi%22%7D', 'data.json');

-- Example with Base64 encoded binary data
SELECT sqlpage.download_file_as_data_url('data:application/octet-stream;base64,SGVsbG8h', 'binary.bin');

-- Example reading file from server (assuming 'my_file.pdf' exists)
SELECT sqlpage.download_file_as_data_url(sqlpage.read_file_as_data_url('my_file.pdf'), 'document.pdf');
```

--------------------------------

### Empty State Component - SQLPage

Source: https://sql-page.com/documentation/.sql

The empty_state component displays a placeholder message with a title, optional icon/image, descriptive text (supporting Markdown), and a call-to-action button. It is ideal for first-use screens, empty data sets, 'no results' pages, or error messages.

```sqlpage
-- Example: No items found message
SELECT sqlpage.empty_state(
  title := 'No items yet!',
  icon := 'sad-face',
  text := 'Your list is currently empty. Add some items to get started.',
  button_label := 'Add Item',
  button_link := '/items/new'
);
```

--------------------------------

### Dynamic Component Rendering - SQLPage

Source: https://sql-page.com/documentation/.sql

The dynamic component renders other components based on provided JSON properties. It is useful for implementing FOR loops, sharing code between pages, or rendering multiple components for each row returned by a SQL query.

```sqlpage
-- Example: Rendering a list of buttons dynamically
SELECT sqlpage.dynamic_content_list(
  'button',
  json_build_object(
    'label', 'Click Me',
    'go', '/page'
  )
) FROM generate_series(1, 3);

-- Example: Rendering different components based on query results
SELECT CASE WHEN type = 'alert' THEN sqlpage.dynamic_content('alert', json_build_object('message', message))
            WHEN type = 'message' THEN sqlpage.dynamic_content('text', json_build_object('text', message))
       END
FROM notifications WHERE user_id = current_user_id();
```

--------------------------------

### Conditionally Redirect User with SQL

Source: https://sql-page.com/documentation/.sql

The `redirect` component stops the current page execution and sends the user to a different page. It's crucial for conditional logic in SQL, especially for error handling or enforcing pre-conditions, as it must be used at the beginning of the SQL file to ensure HTTP headers are not already sent.

```sql
SELECT 'redirect' AS component, 'error_page.sql' AS link WHERE NOT your_condition;
-- The rest of the page is only executed if the condition is true
```

--------------------------------

### Generate RSS Feed Data Flow

Source: https://sql-page.com/documentation/.sql

The `rss` component generates data in RSS format, suitable for podcast feeds. It requires setting the 'application/rss+xml' content type via `http_header` and using `shell-empty` to prevent HTML generation.

```sql
SELECT 'http_header' AS component, 'application/rss+xml' AS mime_type;
SELECT 'shell-empty' AS component;

SELECT 'rss' AS component, title, description, link, pubDate FROM news_items;
```

--------------------------------

### Display Data in a Rich Table

Source: https://sql-page.com/documentation/.sql

The `table` component renders data in a sortable and filterable table. It supports rich content within cells, including images, links, and icons. Rows and columns can be styled using CSS classes, and table appearance can be customized with striping, borders, and hover effects.

```sql
SELECT 'table' AS component, 'Column 1', 'Column 2' FROM my_data;

-- Table with rich content and styling
SELECT 
    'table' AS component,
    '![Image](image.png)' AS "Image",
    'A link to [Google](https://google.com)' AS "Description",
    _sqlpage_css_class
FROM (
    SELECT 
        'styled-row' AS _sqlpage_css_class,
        'value1' AS "Column 1",
        'value2' AS "Column 2"
) AS data;
```

--------------------------------

### Visualize SQL Data on an Interactive Map

Source: https://sql-page.com/documentation/.sql

The map component displays points on a map from latitude and longitude data. It supports rich visualizations from GIS databases using the `geojson` property and can be combined with PostGIS or spatialite for advanced geospatial data handling. It's useful for store locators, delivery route visualization, sales heatmaps, and real-time tracking.

```sql
SELECT 'map' AS component, lat, long FROM locations;

-- Example with GeoJSON
SELECT 'map' AS component, geojson FROM gis_data;
```

--------------------------------

### SQLPage: Set Row-Level Parameters

Source: https://sql-page.com/documentation/.sql

This snippet shows how to set row-level parameters for a SQLPage component by selecting data from a table. These parameters represent the data to be displayed within the component.

```sql
SELECT my_column_1 AS row_level_parameter_1, my_column_2 AS row_level_parameter_2 FROM my_table;
```

--------------------------------

### Foldable List Component - SQLPage

Source: https://sql-page.com/documentation/.sql

The foldable component displays a list of elements that can be individually expanded. This is useful for presenting hierarchical information or collapsible sections.

```sqlpage
-- Example: Foldable list of FAQs
SELECT sqlpage.foldable_list(
  title := 'Frequently Asked Questions',
  items := json_build_array(
    json_build_object('title', 'What is SQLPage?', 'content', 'SQLPage is a framework for building dynamic web applications using SQL.'),
    json_build_object('title', 'How do I use the download component?', 'content', 'Place it at the top of your SQL page and provide a data URL.')
  )
);
```

--------------------------------

### Set HTTP Response Status Code

Source: https://sql-page.com/documentation/.sql

The `status_code` component allows setting the HTTP response code for the current page. This is useful for APIs, handling validation errors, enforcing access controls, or managing SEO by indicating success (200), creation (201), not found (404), or redirection (301, 302).

```sql
SELECT 'status_code' AS component, '404' AS code;
SELECT 'text' AS component, 'Resource not found' AS text;
```

```sql
SELECT 'status_code' AS component, '200' AS code;
SELECT 'json' AS component, data FROM my_api_results;
```
Tokens:
Raw