Comandi console

La console di amministrazione di Konga accetta sia query SQL che una serie di comandi specifici; tutti i comandi sono nella forma .<nome comando>, altrimenti la riga inserita è interpretata come una query SQL. Se il primo carattere è !, il resto della riga viene sempre interpretato come una query SQL, ma nativa per il driver del database attualmente connesso.

Di seguito sono riportate le istruzioni di utilizzo di tutti i comandi disponibili. Ogni comando supporta anche l’opzione -h, qui omessa, che stampa sulla console l’aiuto in linea del comando stesso.

.activate

Attiva il server. Uso:

.activate <serial> <name> <key>

serial: Seriale abbinato al contratto.

name: Nome del licenziatario.

key: Chiave di attivazione.

.add_job

Aggiunge una nuova attività pianifica sul server. Uso:

.add_job [--driver <driver>] [--database <database>] [--tenant <tenant>] [-p <password>] optimize|backup|index <when>

optimize|backup|index: Tipo di attività da pianificare.

when: Stringa di specifica della periodicità (stile cron).

--driver <driver>: Nome del driver a cui applicare questa attività (* = tutti).

--database <database>: Nome del database a cui applicare questa attività (* = tutti).

--tenant <tenant>: Chiave del tenant per cui applicare questa attività (* = tutti).

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.add_tenant

Aggiunge un nuovo tenant sul server. Uso:

.add_tenant [--databases [DRIVER:DATABASE ...]] [-p <password>] <name> <max_clients>

name: Nome del tenant.

max_clients: Numero massimo di postazioni disponibili per questo tenant.

--databases [DRIVER:DATABASE ...]: Database configurati per il tenant, nella forma driver:nome.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.add_web_access_token

Aggiunge un nuovo token di accesso web per il database corrente. Uso:

.add_web_access_token [-p <password>] [-d <desc>] [-e <expire_days>] [-u <user>]

Argomenti opzionali:

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

-d <desc>, --desc <desc>: Descrizione del token.

-e <expire_days>, --expire-days <expire_days>: Numero di giorni alla scadenza.

-u <user>, --user <user>: Nome dell’utente da abbinare al token per l’accesso.

.archive_accounting_year

Archivia un esercizio del database corrente su un altro database di tipo archivio storico. Uso:

.archive_accounting_year [-d <driver>] [--create] [--desc <desc>] [-b] [--position computer|cloud|both] [--optimize] [-p <password>] <company_code> <accounting_year_code> <archive_name>

company_code: Codice dell’azienda.

accounting_year_code: Codice dell’esercizio da archiviare.

archive_name: Nome dell’archivio storico.

-d <driver>, --driver <driver>: Driver del database.

--create: Crea un nuovo archivio storico.

--desc <desc>: Imposta la descrizione dell’archivio storico durante la creazione.

-b, --backup: Esegue un backup del database prima di archiviare l’esercizio.

--position computer|cloud|both: Posizione in cui salvare il backup.

--optimize: Ottimizza il database originale al termine dell’archiviazione.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.backup_database

Esegui il backup di un database. Uso:

.backup_database [-d <driver>] [-p <password>] [-o] [--position computer|cloud|both] [--store-index] <name> <backup_name>

name: Nome del database.

backup_name: Nome del backup.

-d <driver>, --driver <driver>: Driver del database.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

-o, --overwrite: Sovrascrivi il backup se già esiste.

--position computer|cloud|both: Posizione in cui salvare il backup.

--store-index: Includi l’indice di ricerca del database nel backup.

.begin

Inizia una nuova transazione. Uso:

.begin [--no-index]

Argomenti opzionali:

--no-index: Sospendi l’indicizzazione del database durante la transazione.

.binary_data_stats

Ottiene statistiche sui dati binari del database corrente. Uso:

.binary_data_stats

.calc

Calcola il risultato di una espressione matematica. Uso:

.calc ...

expr: Espressione da calcolare.

.clone_database

Duplica un database. Uso:

.clone_database [-d <driver>] [--new-driver <new_driver>] [-p <password>] <name> [<new_name>]

name: Nome del database.

new_name: Nome del nuovo database.

-d <driver>, --driver <driver>: Driver del database.

--new-driver <new_driver>: Driver del nuovo database.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.close_database

Chiude il database corrente. Uso:

.close_database

.cloud_info

Riporta informazioni sullo stato del supporto cloud. Uso:

.cloud_info

.commit

Termina la transazione corrente salvando le modifiche. Uso:

.commit [--index]

Argomenti opzionali:

--index: Riprendi l’indicizzazione del database se precedentemente sospesa.

.config

Ottiene o imposta i settaggi del server. Uso:

.config [-p <password>] list|get|set|help [<key>] [<value>]

list|get|set|help: Azione da eseguire.

key: Chiave da ottenere o impostare.

value: Valore da impostare.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

L’azione list mostra tutte le chiavi dei settaggi disponibili con il relativo valore corrente. Ogni chiave può avere delle restrizioni sul valore che può assumere; l’azione help mostra su console un aiuto in linea sulla configurazione della chiave desiderata.

.connect

Connette ad un nuovo server. Uso:

.connect [-p <port>] [--timeout <timeout>] [--tenant-key <tenant_key>] <host>

host: Indirizzo o nome del server a cui collegarsi.

-p <port>, --port <port>: Porta del server a cui collegarsi.

--timeout <timeout>: Tempo di attesa per effettuare la connessione.

--tenant-key <tenant_key>: Chiave di accesso al server in modalità multi-tenant.

Se la porta è omessa, .connect proverà nell’ordine le porte 51965 (porta standard di Konga), 51966 (porta standard di Konga Server), 51986 e 52006.

.create_database

Crea un nuovo database. Uso:

.create_database [-d <driver>] [--description <description>] [-p <password>] <name>

name: Nome del database.

-d <driver>, --driver <driver>: Driver del database.

--description <description>: Testo di descrizione del database.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.database_stats

Ottiene statistiche sul database corrente. Uso:

.database_stats [-p <password>] [-s name|size|records]

Argomenti opzionali:

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

-s name|size|records, --sort name|size|records: Campo di ordinamento per le statistiche delle tabelle.

.decrypt_backup

Decifra un backup. Uso:

.decrypt_backup [-p <password>] [--position computer|cloud] <name>

name: Nome del backup.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

--position computer|cloud: Posizione in cui si trova il backup.

.del_binary

Elimina una immagine/documento allegato ad un record del database. Uso:

.del_binary [-f <filename>] [-l <label>] [-c <company_code>] doc|image|web|thumb|extra <resource>

doc|image|web|thumb|extra: Tipo di binario da cancellare.

resource: Nome risorsa nella forma <nometabella>:<id>.

-f <filename>, --filename <filename>: Nome del file per identificare il documento da cancellare.

-l <label>, --label <label>: Etichetta per identificare l’immagine aggiuntiva da cancellare.

-c <company_code>, --company-code <company_code>: Codice dell’azienda proprietaria della risorsa.

.delete_backup

Cancella un backup di database. Uso:

.delete_backup [-p <password>] [--position computer|cloud] <backup_name>

backup_name: Nome del backup.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

--position computer|cloud: Posizione in cui si trova il backup.

.delete_database

Cancella un database. Uso:

.delete_database [-d <driver>] [--cloud-data ignore|preserve|delete] [-p <password>] <name>

name: Nome del database.

-d <driver>, --driver <driver>: Driver del database.

--cloud-data ignore|preserve|delete: Comportamento sulla cancellazione dei dati binari nel cloud.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.delete_job

Cancella un’attività pianificata sul server. Uso:

.delete_job [-p <password>] <id>

id: Id dell’attività pianificata.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.delete_tenant

Cancella un tenant dal server. Uso:

.delete_tenant [-p <password>] <key>

key: Chiave di accesso del tenant.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.delete_web_access_token

Cancella un token di accesso web dal database corrente. Uso:

.delete_web_access_token [-p <password>] <token>

token: Token da cancellare.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.disconnect

Disconnette dal server corrente. Uso:

.disconnect

.echo

Stampa un messaggio sulla console. Uso:

.echo ...

message: Messaggio da stampare.

Questo comando può essere utile all’interno degli script di Konga per notificare l’utente dello stato di avanzamento dello script.

.edi_config

Esegue un override sulla configurazione EDI (Electronic Documents Interchange). Uso:

.edi_config get|set|reset ...

get|set|reset: Azione da eseguire.

config: Nuova configurazione in formato json.

.edi_fetch

Riceve uno o più documenti elettronici dall’intermediario. Uso:

.edi_fetch [-c <office_code>] [-f <from_ts>] <company_code> [<id_sdi>]

company_code: Codice dell’azienda per cui ricevere il documento.

id_sdi: Id sdi dello specifico documento da ricevere.

-c <office_code>, --office_code <office_code>: Codice univoco ufficio di ricezione del documento.

-f <from_ts>, --from <from_ts>: Data a partire da cui cercare documenti per la ricezione.

.edi_info

Ottiene informazioni sui contratti EDI (Electronic Documents Interchange) attivi. Uso:

.edi_info

.edit_job

Modifica un’attività pianificata sul server. Uso:

.edit_job [--when <when>] [--driver <driver>] [--database <database>] [--tenant <tenant>] [--enable] [--disable] [-p <password>] <id>

id: Id dell’attività pianificata.

--when <when>: Stringa di specifica della periodicità (stile cron).

--driver <driver>: Nome del driver a cui applicare questa attività (* = tutti).

--database <database>: Nome del database a cui applicare questa attività (* = tutti).

--tenant <tenant>: Chiave del tenant per cui applicare questa attività (* = tutti).

--enable: Abilita l’attività pianificata.

--disable: Disabilita l’attività pianificata.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.edit_tenant

Modifica un tenant sul server. Uso:

.edit_tenant [-n <name>] [-c <max_clients>] [-a [DRIVER:DATABASE ...]] [-r [DRIVER:DATABASE ...]] [--enable] [--disable] [-p <password>] <key>

key: Chiave di accesso del tenant.

-n <name>, --name <name>: Imposta il nome del tenant.

-c <max_clients>, --max-clients <max_clients>: Imposta il numero massimo di postazioni disponibili per questo tenant.

-a [DRIVER:DATABASE ...], --add-database [DRIVER:DATABASE ...]: Aggiunge un database al tenant, nella forma driver:nome.

-r [DRIVER:DATABASE ...], --remove-database [DRIVER:DATABASE ...]: Rimuove un database dal tenant, nella forma driver:nome.

--enable: Abilita il tenant.

--disable: Disabilita il tenant.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.encrypt_backup

Cifra un backup. Uso:

.encrypt_backup [-p <password>] [--position computer|cloud] <name>

name: Nome del backup.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

--position computer|cloud: Posizione in cui si trova il backup.

.get_binary

Scarica una immagine/documento allegato ad un record del database. Uso:

.get_binary [-f <filename>] [-l <label>] [-o <output>] doc|image|web|thumb|extra <resource>

doc|image|web|thumb|extra: Tipo di binario da scaricare.

resource: Nome risorsa nella forma <nometabella>:<id>.

-f <filename>, --filename <filename>: Nome del file del documento da scaricare.

-l <label>, --label <label>: Etichetta assegnata all’immagine aggiuntiva.

-o <output>, --output <output>: Nome del file su cui scrivere il documento scaricato.

.get_binary_storage_type

Ottiene il supporto di archiviazione corrente per il tipo di dati binari specificato. Uso:

.get_binary_storage_type images|attachments

images|attachments: Tipo di dati binari.

.help

Mostra aiuto sul funzionamento della console. Uso:

.help [<command>]

command: Comando per cui visualizzare l’aiuto.

.index

Esegue l’indicizzazione del database per la ricerca full-text. Uso:

.index [-d <driver>] [--reset] [--norun] [-p <password>] <name>

name: Nome del database.

-d <driver>, --driver <driver>: Driver del database.

--reset: Forza la ricostruzione dell’intero indice.

--norun: Non esegue l’indicizzazione adesso (da usare con –reset).

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.index_info

Ottiene informazioni sull’indice di ricerca del database. Uso:

.index_info

.kill_client

Forza la disconnessione dal server della postazione specificata. Uso:

.kill_client [-p <password>] <id>

id: Id della postazione da disconnettere.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.license

Riporta informazioni sulla licenza. Uso:

.license

.list_backups

Mostra la lista dei backup salvati dal server. Uso:

.list_backups [-f computer|cloud] [-a] [--details]

Argomenti opzionali:

-f computer|cloud, --from computer|cloud: Posizione da cui leggere la lista dei backup.

-a, --auto: Includi nella lista anche i backup automatici.

--details: Mostra dettagli aggiuntivi.

.list_binaries

Mostra la lista delle immagini/documenti allegati ad un record del database. Uso:

.list_binaries [-l] <resource>

resource: Nome risorsa nella forma <nometabella>:<id>.

-l, --labels: Mostra anche le etichette delle immagini aggiuntive.

.list_clients

Mostra la lista delle postazioni connesse al server. Uso:

.list_clients [-a]

Argomenti opzionali:

-a, --all: Mostra tutte le connessioni.

.list_databases

Mostra la lista dei database disponibili sul server. Uso:

.list_databases [-d <driver>] [--details]

Argomenti opzionali:

-d <driver>, --driver <driver>: Includi solo i database appartenenti al driver specificato.

--details: Mostra dettagli aggiuntivi.

.list_drivers

Mostra la lista dei driver di database disponibili sul server. Uso:

.list_drivers [-a]

Argomenti opzionali:

-a, --all: Includi tutti i driver nella lista, anche quelli non configurati.

.list_jobs

Mostra l’elenco delle attività pianificate sul server. Uso:

.list_jobs [-p <password>]

Argomenti opzionali:

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.list_locks

Mostra la lista delle risorse in uso sul server. Uso:

.list_locks

.list_servers

Mostra la lista dei server disponibili sulla rete locale. Uso:

.list_servers [-p <port>] [--timeout <timeout>] [--details]

Argomenti opzionali:

-p <port>, --port <port>: Porta udp da cui cominciare la ricerca dei server.

--timeout <timeout>: Tempo di attesa per ricevere eventuali risposte dai server.

--details: Mostra dettagli aggiuntivi.

.list_tenants

Mostra l’elenco dei tenant configurati sul server. Uso:

.list_tenants [-p <password>]

Argomenti opzionali:

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.list_web_access_tokens

Mostra la lista dei token di accesso web configurati per il database corrente. Uso:

.list_web_access_tokens [-p <password>]

Argomenti opzionali:

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.open_database

Apre un database e lo rende il database corrente. Uso:

.open_database [-d <driver>] <name>

name: Nome del database.

-d <driver>, --driver <driver>: Driver del database.

.optimize

Esegue ottimizzazioni di manutenzione su un database. Uso:

.optimize [-d <driver>] [-p <password>] <name>

name: Nome del database.

-d <driver>, --driver <driver>: Driver del database.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.ping

Verifica la presenza del server. Uso:

.ping [<count>]

count: Numero di ping da eseguire.

.query

Esegue una query sul database attualmente connesso. Uso:

.query [-n] [--full-names] [--full-blobs] [--full-text] [--quiet] [-l <limit>] ...

sql: Query sql da eseguire.

-n, --native: La query è nativa per il driver in uso dal database corrente.

--full-names: Restituisce i nomi delle colonne completi di nome tabella nel result set.

--full-blobs: Restituisce il contenuto completo delle colonne di tipo blob.

--full-text: Restituisce il contenuto completo delle colonne di tipo testo.

--quiet: Sopprime la stampa dei risultati.

-l <limit>, --limit <limit>: Massimo numero di righe stampate del risultato; se 0 stampa tutte le righe (default: 2000).

.quit

Termina la sessione corrente. Uso:

.quit [-p]

Argomenti opzionali:

-p, --program: Richiedi uscita dal programma.

.release_lock

Forza il rilascio di una risorsa in uso sul server. Uso:

.release_lock <id> <name> [<row>]

id: Id della postazione da disconnettere.

name: Nome della risorsa da rilasciare.

row: Id della risorsa.

.release_memory

Rilascia la memoria cache utilizzata dal server. Uso:

.release_memory [-f]

Argomenti opzionali:

-f, --full: Prova a rilasciare anche la memoria dello heap.

.repair

Prova a riparare un database danneggiato. Uso:

.repair [-o <output>] [-d <driver>] [-p <password>] <name>

name: Nome del database danneggiato.

-o <output>, --output <output>: Nome del database recuperato.

-d <driver>, --driver <driver>: Driver del database.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.restart_server

Esegue un riavvio del server. Uso:

.restart_server [-p <password>]

Argomenti opzionali:

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.restore_database

Ripristina il contenuto di un backup in un nuovo database. Uso:

.restore_database [-n <name>] [-d <driver>] [-p <password>] [-o] [--position computer|cloud] [--skip-index] <backup_name>

backup_name: Nome del backup.

-n <name>, --name <name>: Nome del database.

-d <driver>, --driver <driver>: Driver del database.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

-o, --overwrite: Sovrascrivi il database se già esiste.

--position computer|cloud: Posizione in cui si trova il backup.

--skip-index: Non ripristina l’indice di ricerca del database dal backup se presente.

.rollback

Termina la transazione corrente tralasciando le modifiche. Uso:

.rollback [--index]

Argomenti opzionali:

--index: Riprendi l’indicizzazione del database se precedentemente sospesa.

.search

Esegue una ricerca full-text sul database corrente. Uso:

.search [-l <limit>] ...

query: Query di ricerca.

-l <limit>, --limit <limit>: Limita i risultati a n righe.

.send_message

Inoltra un messaggio di testo ad una o più postazioni. Uso:

.send_message [-t [<target> ...]] <text>

text: Testo del messaggio.

-t [<target> ...], --target [<target> ...]: Id della postazione destinataria oppure «all» o «*» per tutte le postazioni connesse.

I messaggi inoltrati saranno ricevuti e mostrati dalle postazioni di destinazione ogni 30 secondi circa, il ché significa che con molta probabilità i messaggi non saranno mostrati nell’istante in cui sono spediti.

.server_info

Riporta informazioni sul server attualmente connesso. Uso:

.server_info

.server_stats

Ottiene statistiche interne del server. Uso:

.server_stats [-p <password>]

Argomenti opzionali:

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.set_binary

Carica una immagine/documento come allegato ad un record del database. Uso:

.set_binary [-f <filename>] [-l <label>] [-c <company_code>] doc|image|web|thumb|extra <resource> <input>

doc|image|web|thumb|extra: Tipo di binario da scaricare.

resource: Nome risorsa nella forma <nometabella>:<id>.

input: Nome del file da caricare.

-f <filename>, --filename <filename>: Nome del file da assegnare al documento caricato.

-l <label>, --label <label>: Etichetta da assegnare all’immagine aggiuntiva caricata.

-c <company_code>, --company-code <company_code>: Codice dell’azienda proprietaria della risorsa.

.set_binary_storage_type

Imposta il supporto di archiviazione corrente per il tipo di dati binari specificato. Uso:

.set_binary_storage_type [-p <password>] images|attachments filesystem|database|cloud

images|attachments: Tipo di dati binari.

filesystem|database|cloud: Supporto di archiviazione.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.set_data_language

Imposta la lingua dei dati. Uso:

.set_data_language it|en|nl

it|en|nl: Codice iso della nuova lingua da impostare.

.set_encryption_password

Imposta una nuova password di crittografia dei dati. Uso:

.set_encryption_password [--raw] [-p <password>] [<encryption_password>]

encryption_password: Nuova password crittografica; lasciare vuoto per disabilitare la crittografia dei dati.

--raw: Assume la password come già crittata e codificata in base64.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.time

Cronometra l’esecuzione di un comando o di una query. Uso:

.time ...

command: Comando o query da eseguire.

.upgrade_database

Aggiorna un database all’ultima versione del dizionario dei dati. Uso:

.upgrade_database [-d <driver>] [-p <password>] <name>

name: Nome del database.

-d <driver>, --driver <driver>: Driver del database.

-p <password>, --password <password>: Password del server per autorizzare l’operazione.

.user

Ottiene o cambia l’utente corrente. Uso:

.user [-p <password>] [--renew <renew>] [<name>]

name: Nuovo nome utente.

-p <password>, --password <password>: Password di accesso per l’autenticazione dell’utente.

--renew <renew>: Nuova password di accesso dell’utente in caso di password scaduta.

.uuid

Genera uno o più UUID. Uso:

.uuid [<count>]

count: Numero di uuid da generare.

.version

Riporta informazioni sulla versione. Uso:

.version [-f]

Argomenti opzionali:

-f, --full: Mostra maggiori informazioni.