# Guide to gateway backup IDB structure

**URL:** <https://forum.inductiveautomation.com/t/guide-to-gateway-backup-idb-structure/100678>\
**Category:** Ignition\
**Created:** [January 9, 2025, 7:43pm UTC](https://forum.inductiveautomation.com/t/guide-to-gateway-backup-idb-structure/100678 "2025-01-09T19:43:20Z")\
**Posts on this page:** 6\
**Page:** 1

<div class="post-metadata">

**Author:** ![Leor\_Fishman](https://avatars.discourse-cdn.com/v4/letter/l/e19adc/32.png) [@Leor\_Fishman](https://forum.inductiveautomation.com/u/Leor_Fishman)\
**Post date:** [January 9, 2025, 7:43pm UTC](https://forum.inductiveautomation.com/t/guide-to-gateway-backup-idb-structure/100678/1 "2025-01-09T19:43:20Z")

</div>

I'm looking to analyze the backed up DB file and was wondering if there was a table by table guide to the schema.

---

<div class="post-metadata">

**Author:** ![paul-griffith](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/paul-griffith/32/37249_2.png) [@paul-griffith](https://forum.inductiveautomation.com/u/paul-griffith)\
**Post date:** [January 9, 2025, 7:49pm UTC](https://forum.inductiveautomation.com/t/guide-to-gateway-backup-idb-structure/100678/2 "2025-01-09T19:49:55Z")

</div>

No.  
[Kindling](https://github.com/inductiveautomation/kindling) is open source and has some reference code you could follow to see general well-known structures, but because any module(s) you have could be adding or interacting with any number of tables, plus any tables could have any number of deprecated values depending on version, any documentation we provide is just going to be a bug-for-bug duplicate of whatever the software is already doing, which means it's a maintenance nightmare.

---

<div class="post-metadata">

**Author:** ![Leor\_Fishman](https://avatars.discourse-cdn.com/v4/letter/l/e19adc/32.png) [@Leor\_Fishman](https://forum.inductiveautomation.com/u/Leor_Fishman)\
**Post date:** [January 9, 2025, 9:14pm UTC](https://forum.inductiveautomation.com/t/guide-to-gateway-backup-idb-structure/100678/3 "2025-01-09T21:14:31Z")

</div>

Thanks for Kindling!  
Is there a CLI/API to it, or no?

---

<div class="post-metadata">

**Author:** ![paul-griffith](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/paul-griffith/32/37249_2.png) [@paul-griffith](https://forum.inductiveautomation.com/u/paul-griffith)\
**Post date:** [January 10, 2025, 12:59am UTC](https://forum.inductiveautomation.com/t/guide-to-gateway-backup-idb-structure/100678/4 "2025-01-10T00:59:10Z")

</div>

No, unfortunately I made the mistake early on of not really separating the data model from the GUI; in most cases they're pretty inextricably linked. In past me's defense, I wasn't (and still am not sure) exactly _how_ a CLI or other presentation for the data would actually work; the whole point of Kindling is to be an interactive tool you work with, not really a set-and-repeat mechanism.

---

<div class="post-metadata">

**Author:** ![Leor\_Fishman](https://avatars.discourse-cdn.com/v4/letter/l/e19adc/32.png) [@Leor\_Fishman](https://forum.inductiveautomation.com/u/Leor_Fishman)\
**Post date:** [January 10, 2025, 1:01am UTC](https://forum.inductiveautomation.com/t/guide-to-gateway-backup-idb-structure/100678/5 "2025-01-10T01:01:00Z")

</div>

Well, specifically what I care about is having the ability to run queries over the IDB, which would be enough for me. Agreed in other ways it's challenging.

---

<div class="post-metadata">

**Author:** ![pturmel](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/pturmel/32/3295_2.png) [@pturmel](https://forum.inductiveautomation.com/u/pturmel)\
**Post date:** [January 10, 2025, 1:03am UTC](https://forum.inductiveautomation.com/t/guide-to-gateway-backup-idb-structure/100678/6 "2025-01-10T01:03:23Z")

</div>

The IDB is SQLite. Use the CLI for SQLite. Or one of its APIs. Use Kindling's source code as **guidance** on what to query.
