freqtrade_origin/docs/sql_cheatsheet.md
2024-07-22 19:31:30 +02:00

3.7 KiB

SQL Helper

This page contains some help if you want to query your sqlite db.

!!! Tip "Other Database systems" To use other Database Systems like PostgreSQL or MariaDB, you can use the same queries, but you need to use the respective client for the database system. Click here to learn how to setup a different database system with freqtrade.

!!! Warning If you are not familiar with SQL, you should be very careful when running queries on your database.
Always make sure to have a backup of your database before running any queries.

Install sqlite3

Sqlite3 is a terminal based sqlite application. Feel free to use a visual Database editor like SqliteBrowser if you feel more comfortable with that.

Ubuntu/Debian installation

sudo apt-get install sqlite3

Using sqlite3 via docker

The freqtrade docker image does contain sqlite3, so you can edit the database without having to install anything on the host system.

docker compose exec freqtrade /bin/bash
sqlite3 <database-file>.sqlite

Open the DB

sqlite3
.open <filepath>

Table structure

List tables

.tables

Display table structure

.schema <table_name>

Get all trades in the table

SELECT * FROM trades;

Destructive queries

Queries that write to the database. These queries should usually not be necessary as freqtrade tries to handle all database operations itself - or exposes them via API or telegram commands.

!!! Warning Please make sure you have a backup of your database before running any of the below queries.

!!! Danger You should also never run any writing query (update, insert, delete) while a bot is connected to the database. This can and will lead to data corruption - most likely, without the possibility of recovery.

Fix trade still open after a manual exit on the exchange

!!! Warning Manually selling a pair on the exchange will not be detected by the bot and it will try to sell anyway. Whenever possible, /forceexit should be used to accomplish the same thing.
It is strongly advised to backup your database file before making any manual changes.

!!! Note This should not be necessary after /forceexit, as force_exit orders are closed automatically by the bot on the next iteration.

UPDATE trades
SET is_open=0,
  close_date=<close_date>,
  close_rate=<close_rate>,
  close_profit = close_rate / open_rate - 1,
  close_profit_abs = (amount * <close_rate> * (1 - fee_close) - (amount * (open_rate * (1 - fee_open)))),
  exit_reason=<exit_reason>
WHERE id=<trade_ID_to_update>;

Example

UPDATE trades
SET is_open=0,
  close_date='2020-06-20 03:08:45.103418',
  close_rate=0.19638016,
  close_profit=0.0496,
  close_profit_abs = (amount * 0.19638016 * (1 - fee_close) - (amount * (open_rate * (1 - fee_open)))),
  exit_reason='force_exit'  
WHERE id=31;

Remove trade from the database

!!! Tip "Use RPC Methods to delete trades" Consider using /delete <tradeid> via telegram or rest API. That's the recommended way to deleting trades.

If you'd still like to remove a trade from the database directly, you can use the below query.

!!! Danger Some systems (Ubuntu) disable foreign keys in their sqlite3 packaging. When using sqlite - please ensure that foreign keys are on by running PRAGMA foreign_keys = ON before the above query.

DELETE FROM trades WHERE id = <tradeid>;

DELETE FROM trades WHERE id = 31;

!!! Warning This will remove this trade from the database. Please make sure you got the correct id and NEVER run this query without the where clause.