### Download and Run Mathesar Install Script

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.10.1.md

Download the 0.10.1 install script, make it executable, and then run it in your installation directory to perform the upgrade. This script handles both fresh installs and upgrades for non-Docker setups.

```bash
curl -sSfL https://github.com/mathesar-foundation/mathesar/releases/download/0.10.1/install.sh -o install.sh
chmod +x install.sh

./install.sh .
```

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

### Example PostgreSQL Connection Strings

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-from-scratch.md

Illustrates various formats for PostgreSQL connection strings that can be used with the install script.

```sql
postgres://mathesar:strong‑pw‑here@localhost:5432/mathesar_django

# As parameters
postgres:///mathesar_django/?host=localhost&port=5432&user=mathesar&password=strong‑pw‑here

# Over Unix domain sockets
postgres://mathesar:strong‑pw‑here@/mathesar_django?host=/var/run/postgresql

# Non-standard port over Unix domain sockets
postgres://mathesar:strong‑pw‑here@%2Fvar%2Flib%2Fpostgresql:5455/mathesar_django
```

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

### Start Development Server

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/DEVELOPER_GUIDE.md

Starts the development services, including the web and database servers, using Docker Compose. Ensure Docker is installed and running.

```bash
docker compose -f docker-compose.dev.yml up dev-service
```

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

### Download and Run Mathesar 0.3.0 Install Script

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.3.0.md

Download the install script, make it executable, and then run it to perform the upgrade. This script automates the installation and upgrade process for direct installations.

```bash
curl -sSfL https://github.com/mathesar-foundation/mathesar/releases/download/0.3.0/install.sh -o install.sh
chmod +x install.sh

./install.sh .
```

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

### Copy Environment File

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/DEVELOPER_GUIDE.md

Copies the example environment file to a new file named .env. This is a necessary step before starting the development server.

```bash
cp .env.example .env
```

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

### Download and Run Mathesar Install Script

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.7.1.md

Download the install script for version 0.7.1, make it executable, and then run it in your installation directory to perform the upgrade.

```bash
curl -sSfL https://github.com/mathesar-foundation/mathesar/releases/download/0.7.1/install.sh -o install.sh
chmod +x install.sh

./install.sh .
```

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

### Download and Run Mathesar 0.6.0 Install Script

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.6.0.md

Download the install script for version 0.6.0, make it executable, and then run it. This script handles both fresh installs and upgrades.

```bash
curl -sSfL https://github.com/mathesar-foundation/mathesar/releases/download/0.6.0/nstall.sh -o install.sh
chmod +x install.sh

./install.sh .
```

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

### Download and Run Mathesar 0.4.0 Install Script

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.4.0.md

Download the install script for version 0.4.0, make it executable, and then run it to perform the installation or upgrade.

```bash
curl -sSfL https://github.com/mathesar-foundation/mathesar/releases/download/0.4.0/install.sh -o install.sh
chmod +x install.sh

./install.sh .
```

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

### Download and Run Mathesar 0.5.0 Install Script

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.5.0.md

Download the install script for version 0.5.0, make it executable, and then run it. This script automates fresh installs and upgrades.

```bash
curl -sSfL https://github.com/mathesar-foundation/mathesar/releases/download/0.5.0/nstall.sh -o install.sh
chmod +x install.sh

./install.sh .
```

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

### Initialize New Mathesar Installation with Docker Compose

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.1.4.md

Start the Mathesar services using the updated `docker-compose.yml`. This command pulls new images and starts the containers in detached mode.

```bash
docker compose -f xMATHESAR_INSTALLATION_DIRx/docker-compose.yml up -d
```

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

### Download and Make Install Script Executable

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-from-scratch.md

Download the Mathesar install script and grant it execute permissions.

```bash
curl -sSfL https://github.com/mathesar-foundation/mathesar/releases/download/{{mathesar_version}}/install.sh -o install.sh
chmod +x install.sh
```

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

### Install Docs Dependencies

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/README.md

Ensure you have the necessary docs-related dependencies installed by installing from the `requirements.txt` file. These dependencies are separate from the Mathesar application dependencies.

```bash
pip install -r ./requirements.txt
```

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

### Run Mathesar Install Script

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-from-scratch.md

Execute the install script, providing the PostgreSQL connection string.

```bash
./install.sh . \
  -c "postgres://mathesar:strong‑pw‑here@localhost:5432/mathesar_django"
```

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

### Install Requirements

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/README.md

Install the necessary Python packages for local documentation preview.

```bash
pip install -r requirements.txt
```

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

### Database Setup Methods

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/api/methods.md

Methods for setting up new or connecting to existing databases.

```APIDOC
## Database Setup Methods

### `databases.setup.create_new(setup_info)`

Creates a new database.

### `databases.setup.connect_existing(connection_info)`

Connects to an existing database.

### `DatabaseConnectionResult`

Result of a database connection attempt.
```

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

### Start MkDocs Server

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/README.md

Start the MkDocs development server to preview documentation changes locally. The preview will automatically refresh on edits.

```bash
mkdocs serve -a localhost:9000
```

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

### Navigate to Mathesar Installation Directory

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.1.7.md

Change to your Mathesar installation directory. Ensure you replace 'xMATHESAR_INSTALLATION_DIRx' with your actual installation path.

```bash
cd xMATHESAR_INSTALLATION_DIRx
```

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

### Download and Run Mathesar 0.10.0 Install Script

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.10.0.md

Download the install script for version 0.10.0, make it executable, and then run it in your installation directory to perform the upgrade.

```bash
curl -sSfL https://github.com/mathesar-foundation/mathesar/releases/download/0.10.0/install.sh -o install.sh
chmod +x install.sh

./install.sh .
```

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

### Navigate to Installation Directory

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-from-scratch.md

Changes the current directory to the Mathesar installation directory. Replace 'xMATHESAR_INSTALL_DIRx' with your chosen path.

```sh
cd "xMATHESAR_INSTALL_DIRx"
```

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

### Download and Run Mathesar 0.7.0 Install Script

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.7.0.md

Download the install script for version 0.7.0, make it executable, and then run it in your installation directory to perform the upgrade.

```bash
curl -sSfL https://github.com/mathesar-foundation/mathesar/releases/download/0.7.0/nstall.sh -o install.sh
chmod +x install.sh

./install.sh .
```

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

### Create and Set Permissions for Installation Directory

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-from-scratch.md

Creates the Mathesar installation directory and sets ownership to the current user. Replace 'xMATHESAR_INSTALL_DIRx' with your chosen path.

```sh
mkdir -p "xMATHESAR_INSTALL_DIRx"
chown "$(id -u):$(id -g)" "xMATHESAR_INSTALL_DIRx"
```

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

### Download and Run Mathesar 0.11.0 Install Script

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.11.0.md

Download the official install script for version 0.11.0, make it executable, and then run it to perform the upgrade. The '.' indicates the current directory.

```bash
curl -sSfL https://github.com/mathesar-foundation/mathesar/releases/download/0.11.0/install.sh -o install.sh
chmod +x install.sh

./install.sh .
```

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

### Install Frontend Dependencies

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.1.4.md

Install the necessary Node.js packages for the Mathesar frontend using npm ci.

```bash
npm ci --prefix mathesar_ui
```

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

### Navigate to Mathesar Installation Directory

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.10.1.md

Change to your Mathesar installation directory before running the upgrade script. Replace 'xMATHESAR_INSTALL_DIRx' with your actual installation path.

```bash
cd xMATHESAR_INSTALL_DIRx
```

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

### Download and Run Mathesar 0.8.0 Install Script

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.8.0.md

Download the install script for version 0.8.0, make it executable, and run it to perform the upgrade.

```bash
curl -sSfL https://github.com/mathesar-foundation/mathesar/releases/download/0.8.0/install.sh -o install.sh
chmod +x install.sh

./install.sh .
```

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

### Download and Run Mathesar 0.9.0 Install Script

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.9.0.md

Download the install script for version 0.9.0, make it executable, and run it in the current directory.

```bash
curl -sSfL https://github.com/mathesar-foundation/mathesar/releases/download/0.9.0/install.sh -o install.sh
chmod +x install.sh

./install.sh .
```

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

### Start Mathesar Service

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-from-scratch.md

Run the Mathesar application. This command starts the Mathesar service, making it accessible via a web browser.

```bash
mathesar run
```

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

### Install Transifex CLI Tool

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/DEVELOPER_GUIDE.md

Install the Transifex Command Line Interface tool. This is a prerequisite for pulling and pushing translation files.

```bash
curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash
```

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

### Create Installation Directory with Superuser Privileges

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-from-scratch.md

Creates a Mathesar installation directory outside the home folder using superuser privileges. Replace '/etc/mathesar' with your chosen path and '<desired-owner>:<desired-group>' with appropriate user and group.

```sh
sudo mkdir -p /etc/mathesar
sudo chown <desired-owner>:<desired-group> /etc/mathesar
```

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

### Install Dependencies and Capture Screenshots

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/assets/readme/README.md

Installs npm dependencies for the readme assets and then captures screenshots. The --reset flag ensures a clean database state before capturing.

```sh
npm --prefix assets/readme ci
npm --prefix assets/readme run capture -- --base-url http://localhost:8000 --reset
```

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

### Verify Mathesar Installation

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-from-scratch.md

Check if Mathesar is installed correctly by running the version command.

```bash
mathesar version
```

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

### Start Local Development App

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/assets/readme/README.md

Starts the local development environment for Mathesar using Docker Compose. Ensure the app is reachable at http://localhost:8000 with default credentials.

```sh
docker compose -f docker-compose.dev.yml up dev-service
```

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

### Install Build Tools

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-from-scratch.md

Install necessary build tools and headers if the Python dependency build fails. This command is for Debian/Ubuntu-based systems.

```bash
build-essential python3-dev libpq-dev
```

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

### Start Development Services with Object Storage

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/DEVELOPER_GUIDE.md

Launch the Mathesar development environment, including the object storage service, which is required for the file attachment feature.

```bash
docker compose -f docker-compose.dev.yml up dev-service obj-store
```

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

### Start Vite Development Server

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/mathesar_ui/README.md

Starts a Vite development server on port 3000 for local frontend development when not using Docker. Changes are reflected immediately via hot module replacement.

```bash
npm run dev
```

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

### Manage Mathesar systemd Service

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-from-scratch.md

Commands to reload systemd, start the Mathesar service, and enable it to start on boot. Ensure Mathesar is running correctly after these operations.

```bash
sudo systemctl daemon-reload
sudo systemctl start mathesar.service
sudo systemctl enable mathesar.service
```

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

### Start Mathesar After Rollback

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.2.1.md

After restoring the previous configuration, use this command to restart Mathesar.

```bash
docker compose up -d
```

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

### FormBuilder Usage Example

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/mathesar_ui/src/component-library/form-builder/__meta__/FormBuilder.mdx

Demonstrates how to import and use the FormBuilder component with a form configuration. Ensure to import `makeForm` and `FormBuilder` from '@mathesar-component-library'.

```html
<script>
  import { makeForm, FormBuilder } from '@mathesar-component-library';
  const formConfig = { ... };
  const form = makeForm(formConfig);
</script>

<FormBuilder {form}/>
```

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

### Download Docker Compose File

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-via-docker-compose.md

Use wget to download the docker-compose.yml file for Mathesar installation. Ensure you replace {{mathesar_version}} with the desired Mathesar version.

```bash
wget https://github.com/mathesar-foundation/mathesar/raw/{{mathesar_version}}/docker-compose.yml
```

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

### Run Mathesar Manually

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.11.0.md

If not running Mathesar as a service and only on localhost, you can start it manually using this command after removing gunicorn and caddy services.

```bash
mathesar run
```

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

### Example JSON-RPC Request for tables.list

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/api/index.md

This is an example payload for calling the `tables.list` RPC method to retrieve information about tables within a specific schema and database. Ensure that appropriate session and CSRF headers are included in the HTTP request.

```json
{
  "jsonrpc": "2.0",
  "id": 234,
  "method": "tables.list",
  "params": {
    "schema_oid": 47324,
    "database_id": 1
  }
}
```

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

### Create PostgreSQL Database

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-via-docker-compose.md

Use this command to create a new PostgreSQL database for Mathesar's metadata. Ensure you have PostgreSQL client tools installed.

```bash
psql -c 'create database mathesar_django;'
```

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

### Run npm ci Locally

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/mathesar_ui/README.md

Installs project dependencies locally. This is an alternative to container-based dependency management and is primarily used to help IDEs with intellisense and linting.

```bash
npm ci
```

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

### Remove Previous Mathesar Installation

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.2.0.md

Delete the previous Mathesar installation directory. This command assumes Mathesar is installed in `/etc/mathesar`.

```bash
rm -rf /etc/mathesar
```

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

### Start Mathesar in Detached Mode

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-via-docker-compose.md

Start Mathesar services in detached mode (-d flag) to run them in the background. This allows you to continue using your terminal after the containers have started.

```bash
docker compose -f docker-compose.yml up -d
```

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

### Serve Docs Locally

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/README.md

Preview the documentation site locally by running `mike serve`. This allows you to open a browser and preview the site as GitHub will serve it from the `gh-pages` branch, including the version switcher. It does not test custom version redirection behavior.

```bash
mike serve
```

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

### Download and Extract Frontend Assets

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.1.6.md

Download the static files for Mathesar 0.1.6, extract them, and move them to the correct location. Remove the downloaded zip file afterwards.

```bash
wget https://github.com/mathesar-foundation/mathesar/releases/download/0.1.6/static_files.zip
unzip static_files.zip && mv static_files mathesar/static/mathesar && rm static_files.zip
```

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

### Remove Mathesar Installation Directory

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/uninstall.md

Removes the Mathesar installation directory recursively. Use caution as this command may require sudo privileges and can delete user-customized directories.

```bash
rm -r xMATHESAR_INSTALLATION_DIRx  # May need sudo, depending on location
```

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

### Download and Extract Frontend Assets

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.2.4.md

Download the static files for Mathesar 0.2.4, extract them, and place them in the correct directory. This step is necessary for the frontend to function correctly.

```bash
wget https://github.com/mathesar-foundation/mathesar/releases/download/0.2.4/static_files.zip
unzip static_files.zip && mv static_files mathesar/static/mathesar && rm static_files.zip
```

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

### Caddy reverse proxy domain name examples

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/environment-variables.md

Examples of public URLs or hostnames for accessing Mathesar via Caddy. The protocol determines HTTP or HTTPS behavior.

```text
https://example.com
```

```text
localhost
```

```text
http://localhost
```

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

### Download and Extract Frontend Assets

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.2.5.md

Download the static files for Mathesar 0.2.5, extract them, and move them to the correct directory. This step is necessary for the frontend to function correctly.

```bash
wget https://github.com/mathesar-foundation/mathesar/releases/download/0.2.5/static_files.zip
unzip static_files.zip && mv static_files mathesar/static/mathesar && rm static_files.zip
```

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

### Download and Extract Frontend Assets

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.1.7.md

Download the static assets for version 0.1.7, extract them, move them to the correct Mathesar static directory, and then remove the downloaded zip file.

```bash
wget https://github.com/mathesar-foundation/mathesar/releases/download/0.1.7/static_files.zip
unzip static_files.zip && mv static_files mathesar/static/mathesar && rm static_files.zip
```

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

### Mutable Class Pattern - Public Store Example

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/mathesar_ui/ARCHITECTURE.md

Example of a mutable class pattern where the underlying Svelte store is publicly accessible. This pattern is being discouraged in favor of more controlled access.

```typescript
export class RecordsData {
  public records: Writable<Array<Record>>;

  constructor(records: Array<Record>) {
    this.records = writable(records);
  }
}
```

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

### Run Mathesar Locally with Docker

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/index.md

Use this command to quickly try Mathesar locally. It's not recommended for production or saving important data. Ensure Docker is installed.

```bash
docker run -it --name mathesar -p 8000:8000 mathesar/mathesar:latest
```

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

### Download and Extract Frontend Assets

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.2.1.md

Download the static files for Mathesar 0.2.1, extract them, move them to the correct location, and clean up the downloaded archive.

```bash
wget https://github.com/mathesar-foundation/mathesar/releases/download/0.2.1/static_files.zip
unzip static_files.zip && mv static_files mathesar/static/mathesar && rm static_files.zip
```

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

### RPC Method Call Example

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/api/index.md

Example of how to call an RPC method, specifically `tables.list`, using a JSON-RPC v2.0 payload. This demonstrates the structure for sending requests to the API, including the method name and parameters.

```APIDOC
## POST /api/rpc/v0/

### Description
This endpoint is used to make RPC calls to Mathesar's backend.

### Method
POST

### Endpoint
/api/rpc/v0/

### Parameters
#### Request Body
- **jsonrpc** (string) - Required - Specifies the JSON-RPC protocol version.
- **id** (integer) - Required - An identifier for the request.
- **method** (string) - Required - The name of the RPC method to call (e.g., `tables.list`).
- **params** (object) - Optional - An object containing the parameters for the RPC method.

### Request Example
```json
{
  "jsonrpc": "2.0",
  "id": 234,
  "method": "tables.list",
  "params": {
    "schema_oid": 47324,
    "database_id": 1
  }
}
```

### Response
#### Success Response (200)
- **jsonrpc** (string) - The JSON-RPC protocol version.
- **id** (integer) - The identifier for the request.
- **result** (any) - The result returned by the RPC method.

#### Response Example
```json
{
  "jsonrpc": "2.0",
  "id": 234,
  "result": <any>
}
```

#### Error Response
- **jsonrpc** (string) - The JSON-RPC protocol version.
- **id** (integer) - The identifier for the request.
- **error** (object) - An object containing error details.
  - **code** (integer) - The error code.
  - **message** (string) - A description of the error.

#### Error Response Example
```json
{
  "jsonrpc": "2.0",
  "id": 234,
  "error": {
    "code": -32601,
    "message": "Method not found"
  }
}
```
```

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

### Navigate to Docs Directory

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/README.md

Change the current directory to the `docs` directory within the project root.

```bash
cd docs
```

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

### Install Android Debug Bridge (ADB)

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/mathesar_ui/README.md

Install the Android Debug Bridge on your Linux system to enable remote debugging for Firefox on Android devices. This is a prerequisite for accessing browser dev tools on a mobile device.

```bash
sudo apt install android-tools-adb
```

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

### Download and Extract Frontend Assets

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.2.2.md

Download the static frontend assets for version 0.2.2, extract them, move them to the correct Mathesar static directory, and then remove the downloaded zip file.

```bash
wget https://github.com/mathesar-foundation/mathesar/releases/download/0.2.2/static_files.zip
unzip static_files.zip && mv static_files mathesar/static/mathesar && rm static_files.zip
```

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

### Make Mathesar Available System-Wide

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/install-from-scratch.md

Create a system-wide symlink for the Mathesar executable and set appropriate file permissions for all users.

```bash
sudo ln -s "xMATHESAR_INSTALL_DIRx/bin/mathesar" /usr/local/bin/mathesar
```

```bash
sudo chmod -R a+rX xMATHESAR_INSTALL_DIRx
```

```bash
sudo chmod -R a+rwX xMATHESAR_INSTALL_DIRx/.media
```

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

### Databases Methods

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/api/methods.md

Methods for managing databases, including getting information, deleting, and upgrading.

```APIDOC
## Databases Methods

### `databases.get(database_id)`

Gets information about a specific database.

### `databases.delete(database_id)`

Deletes a database.

### `databases.upgrade_sql(database_id)`

Upgrades the SQL schema for a database.

### `DatabaseInfo`

Information about a database.
```

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

### Connect to Docker Container and Navigate to UI Directory

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/mathesar_ui/README.md

Connect to the Mathesar development Docker container and navigate to the UI directory to manage packages. Always perform npm operations within the container to maintain consistency and avoid conflicts with local setups.

```bash
docker exec -it mathesar_service_dev /bin/bash
cd mathesar_ui
```

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

### Schemas Methods

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/api/methods.md

Methods for managing schemas, including listing, getting, adding, deleting, and patching.

```APIDOC
## Schemas Methods

### `schemas.list_()`

Lists all schemas.

### `schemas.get(schema_id)`

Gets a specific schema.

### `schemas.add(schema_info)`

Adds a new schema.

### `schemas.delete(schema_id)`

Deletes a schema.

### `schemas.patch(schema_id, schema_patch)`

Patches an existing schema.

### `SchemaInfo`

Information about a schema.

### `SchemaPatch`

Patch object for schemas.
```

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

### FormBuilder If Condition Story

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/mathesar_ui/src/component-library/form-builder/__meta__/FormBuilder.mdx

Renders the FormBuilder component with an 'if' condition example, as defined in its Storybook story.

```javascript
import { Story, Canvas, ArgsTable, Source } from '@storybook/addon-docs/blocks';
import FormBuilder from '../FormBuilder.svelte';

// ... other imports and configurations

<Canvas withSource="none">
  <Story name="ifExample" id="systems-formbuilder--if-condition" />
</Canvas>
```

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

### Basic Icon Usage

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/mathesar_ui/src/component-library/icon/__meta__/Icon.mdx

Demonstrates the basic implementation of the Icon component. Import the desired icon from '@fortawesome/free-solid-svg-icons' and pass it to the 'data' prop of the Icon component.

```html
<script>
  import { faCat } from '@fortawesome/free-solid-svg-icons';
  import { Icon } from '@mathesar-component-library';
</script>

<Icon data={faCat} />
```

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

### Users Methods

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/api/methods.md

Methods for managing users, including listing, getting, adding, deleting, patching, and revoking.

```APIDOC
## Users Methods

### `users.list_()`

Lists all users.

### `users.get(user_id)`

Gets a specific user.

### `users.add(user_def)`

Adds a new user.

### `users.delete(user_id)`

Deletes a user.

### `users.patch_self(user_patch)`

Patches the current user's information.

### `users.patch_other(user_id, user_patch)`

Patches another user's information.

### `users.replace_own(user_def)`

Replaces the current user's information.

### `users.revoke(user_id, permission)`

Revokes a permission from a user.

### `UserInfo`

Information about a user.

### `UserDef`

Definition of a user.
```

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

### Explorations Methods

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/api/methods.md

Methods for managing explorations, including listing, getting, adding, deleting, replacing, and running.

```APIDOC
## Explorations Methods

### `explorations.list_()`

Lists all explorations.

### `explorations.get(exploration_id)`

Gets a specific exploration.

### `explorations.add(exploration_def)`

Adds a new exploration.

### `explorations.delete(exploration_id)`

Deletes an exploration.

### `explorations.replace(exploration_id, exploration_def)`

Replaces an existing exploration.

### `explorations.run(exploration_id)`

Runs an exploration.

### `ExplorationInfo`

Information about an exploration.

### `ExplorationDef`

Definition of an exploration.

### `ExplorationResult`

Result of running an exploration.
```

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

### Download and Extract Frontend Assets

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.2.3.md

Download the static frontend assets for version 0.2.3, extract them, and place them in the correct directory. This step is crucial for the frontend to function correctly.

```bash
wget https://github.com/mathesar-foundation/mathesar/releases/download/0.2.3/static_files.zip
unzip static_files.zip && mv static_files mathesar/static/mathesar && rm static_files.zip
```

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

### Update Mathesar Functions

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.1.4.md

Update Mathesar functions on the database using the install script. Output is redirected to a log file.

```bash
python mathesar/install.py --skip-confirm >> /tmp/install.py.log
```

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

### Update Python Dependencies

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.1.7.md

Install or update Python packages required for Mathesar production use by referencing the 'requirements-prod.txt' file.

```bash
pip install -r requirements-prod.txt
```

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

### Disable and Stop Mathesar Service

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/uninstall.md

Disables the Mathesar service from starting on boot and then stops the currently running Mathesar service.

```bash
systemctl disable mathesar.service
systemctl stop mathesar.service
```

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

### Run All Unit Tests

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/mathesar_ui/README.md

Execute all unit tests within the Mathesar UI development environment using Docker.

```bash
docker exec -it -w /code/mathesar_ui mathesar_service_dev npm test
```

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

### Disable and Stop Caddy Service

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/administration/uninstall.md

Disables the Caddy service from starting on boot and then stops the currently running Caddy service.

```bash
systemctl disable caddy.service && systemctl stop caddy.service
```

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

### Download New Docker Compose File

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/docs/docs/releases/0.2.0.md

Download the docker-compose.yml file for Mathesar version 0.2.0.

```bash
cd /etc/mathesar
```

```bash
wget https://github.com/mathesar-foundation/mathesar/raw/0.2.0/docker-compose.yml
```

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

### FormBuilder Switch Case Story

Source: https://github.com/mathesar-foundation/mathesar/blob/develop/mathesar_ui/src/component-library/form-builder/__meta__/FormBuilder.mdx

Renders the FormBuilder component with a 'switch case' condition example, as defined in its Storybook story.

```javascript
import { Story, Canvas, ArgsTable, Source } from '@storybook/addon-docs/blocks';
import FormBuilder from '../FormBuilder.svelte';

// ... other imports and configurations

<Canvas withSource="none">
  <Story name="switchCase" id="systems-formbuilder--switch-condition" />
</Canvas>
```