Custom name for Foreign Key.

[nbowisdar]

Hello, is it possible to set a name instead of fk numbers?

It would be pretty convenient if the name changed after updating str method

Thank you.

[dantownsend]

Yes, it's possible.

Piccolo doesn't use the __str__ method to determine how the row is displayed. Instead it looks for a get_readable method:

https://piccolo-orm.readthedocs.io/en/latest/piccolo/schema/advanced.html#readable

Here's an example:

# tables.py
from piccolo.table import Table
from piccolo.columns import Varchar
from piccolo.columns.readable import Readable


class Band(Table, tablename="music_band"):
    name = Varchar(length=100)

    @classmethod
    def get_readable(cls):
        return Readable(template="%s", columns=[cls.name])

I had a look, and we don't seem to mention it in the Piccolo Admin docs, only the main Piccolo docs, so this needs changing.

The reason we use get_readable is this is actually run in the database, so it's more efficient that calling __str__ on each row.

[nbowisdar]

Thank you very much!