PgArachne Explorer

1 λεπτά ανάγνωσης

PgArachne Explorer

Το Explorer είναι ένα ισχυρό web GUI που περιλαμβάνεται στον κατάλογο tools/pgarachne-explorer. Δεν είναι απλά ένα εργαλείο τεκμηρίωσης — είναι μια πλήρως λειτουργική εφαρμογή επίδειξης χτισμένη με HTML/JS που επικοινωνεί με τη βάση δεδομένων αποκλειστικά μέσω του PgArachne. Μια φιλοξενούμενη έκδοση είναι επίσης διαθέσιμη στο explorer.pgarachne.com.

Τι μπορεί να κάνει;

  • Επιθεώρηση API: Διαβάζει τη συνάρτηση capabilities για να εμφανίσει όλα τα διαθέσιμα endpoints και τις παραμέτρους τους.
  • Ζωντανή Δοκιμή: Μπορείτε να εκτελέσετε συναρτήσεις απευθείας από τον browser.
  • Αυτόματη Τεκμηρίωση: Αποδίδει τα σχόλια SQL (συμπεριλαμβανομένων των μεταδεδομένων --- PARAMS ---) σε ευανάγνωστη τεκμηρίωση.
  • Μοντέρνο UI: Διαθέτει υποστήριξη λειτουργίας Dark/Light και μπορεί να εγκατασταθεί ως PWA σε κινητές συσκευές.
  • Πιστοποίηση: Η καρτέλα Password χρησιμοποιεί HTTP Basic Auth για απευθείας σύνδεση ως ο χρήστης της βάσης δεδομένων — δεν απαιτείται GRANT … TO pgarachne. Η καρτέλα API Token δέχεται ένα JWT ή μακρόβιο API token που αποστέλλεται ως Bearer.

Παράμετροι URL:

Μπορείτε να προσυμπληρώσετε τις ρυθμίσεις σύνδεσης χρησιμοποιώντας την παράμετρο ?url=, για παράδειγμα: ?url=http://localhost:8080/db/my_database. Αυτό θα χωρίσει αυτόματα το URL στα πεδία API Host, Prefix, και Database.

Πώς να το ενεργοποιήσετε: Ρυθμίστε τη μεταβλητή περιβάλλοντος STATIC_FILES_PATH ώστε να δείχνει στον φάκελο tools/pgarachne-explorer στον δίσκο σας. Στη συνέχεια, επισκεφθείτε το http://localhost:8080.