Charmed MySQL K8s How To - Integrate with my charm

How to integrate DB with my charm

Please check the supported interfaces of the current charm first. You have options to use modern (preferred) or legacy interfaces. Make sure you are familiar with Juju integration concepts.

The most existing charms currently use ops-lib-mysql interface (legacy). Canonical recommends for new charms to use data-platform-libs instead. You can take a look at mysql-test-app for more practical examples. Consider to read the great manual about the charm development. The legacy charm details are well described here.


  • Q: Does the requirer need to set anything in relation data?
    A: it depends on the interface. Check the mysql_client interface requirements.
  • Q: Is there a charm library available, or does my charm need to compile the mysql relation data on its own?
    A: Yes, the library is available: data-platform-libs.
  • Q: How do I obtain the database url/uri?
    A: it is planned, but currently missing. Meanwhile use PostgreSQL as an example.


Contact us if you have any questions, issues and/or ideas!