SQLPage built-in functions

In addition to normal SQL functions supported by your database, SQLPage provides a few special functions to help you extract data from user requests.

These functions are special, because they are not executed inside your database, but by SQLPage itself before sending the query to your database. Thus, they require all the parameters to be known at the time the query is sent to your database. Function parameters cannot reference columns from the rest of your query.

The sqlpage.read_file_as_text function

Introduced in SQLPage 0.17.0.

Returns a string containing the contents of the given file.

The file must be a raw text file using UTF-8 encoding.

The file path is relative to the web root directory, which is the directory from which your website is served (not necessarily the directory SQLPage is launched from).

If the given argument is null, the function will return null.

As with other functions, if an error occurs during execution (because the file does not exist, for instance), the function will display an error message and the database query will not be executed.

If you are using a sqlpage_files table to store files directly in the database (serverless mode), the function will attempt to read the file from the database filesystem if it is not found on the local disk, using the same logic as for serving files in response to HTTP requests.


Rendering a markdown file

select 'text' as component, sqlpage.read_file_as_text('/path/to/file.md') as text;



Path to the file to read.

Official SQLPage documentation