The sqlpage.link function

Introduced in SQLPage 0.25.0.

Returns the URL of a SQLPage file with the given parameters.

Example

Let's say you have a database of products, and you want the main page (index.sql) to link to the page of each product (product.sql) with the product name as a parameter.

In index.sql, you can use the link function to generate the URL of the product page for each product:

select 'list' as component;
select
    name as title,
    sqlpage.link('product.sql', json_object('product_name', name)) as link;

Using sqlpage.link is better than manually constructing the URL with CONCAT('product.sql?product_name=', name), because it ensures that the URL is properly encoded. The former works when the product name contains special characters like &, while the latter would break the URL.

In product.sql, you can then use $product_name to get the name of the product from the URL parameter:

select 'text' as component;
select CONCAT('Product: ', $product_name) as contents;

Parameters

• file (TEXT): The name of the SQLPage file to link to.
• parameters (JSON): The parameters to pass to the linked file.
• fragment (TEXT): An optional fragment (hash) to append to the URL. This is useful for linking to a specific section of a page. For instance if product.sql contains select 'text' as component, 'product_description' as id;, you can link to the product description section with sqlpage.link('product.sql', json_object('product_name', name), 'product_description').

Parameters