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.

.add_job

Aggiunge una nuova attività pianifica sul server. Uso:

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

Tipo di attività da pianificare

when

Stringa di specifica della periodicità (stile cron)

Argomenti opzionali:

--driver <driver>

Nome del driver a cui applicare questa attività (* = tutti)

--database <database>

Nome del database a 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 [[DRIVER:]DATABASE ...]]] <name> <max_clients>
name

Nome del tenant

max_clients

Numero massimo di postazioni disponibili per questo tenant

Argomenti opzionali:

--databases [[DRIVER:]DATABASE [[DRIVER:]DATABASE ...]]

Database configurati per il tenant, nella forma driver:nome

.backup_database

Esegui il backup di un database. Uso:

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

Nome del database

backup_name

Nome del backup

Argomenti opzionali:

-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

Posizione da cui leggere la lista dei backup

.begin

Inizia una nuova transazione. Uso:

.begin [--no-index]

Argomenti opzionali:

--no-index

Sospendi l’indicizzazione del database durante la transazione

.calc

Calcola il risultato di una espressione matematica. Uso:

.calc ...
expr

Espressione da calcolare

.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

Argomenti opzionali:

-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

Argomenti opzionali:

-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

Argomenti opzionali:

-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

.delete_backup

Cancella un backup di database. Uso:

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

Nome del backup

Argomenti opzionali:

-p <password>, --password <password>

Password del server per autorizzare l’operazione

--position computer|cloud

Posizione da cui leggere la lista dei backup

.delete_database

Cancella un database. Uso:

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

Nome del database

Argomenti opzionali:

-d <driver>, --driver <driver>

Driver del database

-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

Argomenti opzionali:

-p <password>, --password <password>

Password del server per autorizzare l’operazione

.delete_tenant

Cancella un tenant dal server. Uso:

.delete_tenant <key>
key

Chiave di accesso del tenant

.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.

.edit_job

Modifica un’attività pianificata sul server. Uso:

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

Id dell’attività pianificata

Argomenti opzionali:

--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)

--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 [[DRIVER:]DATABASE ...]]] [-r [[DRIVER:]DATABASE [[DRIVER:]DATABASE ...]]] [--enable] [--disable] <key>
key

Chiave di accesso del tenant

Argomenti opzionali:

-n <name>, --name <name>

Nome del tenant

-c <max_clients>, --max-clients <max_clients>

Numero massimo di postazioni disponibili per questo tenant

-a [[DRIVER:]DATABASE [[DRIVER:]DATABASE ...]], --add-database [[DRIVER:]DATABASE [[DRIVER:]DATABASE ...]]

Aggiunge un database al tenant, nella forma driver:nome

-r [[DRIVER:]DATABASE [[DRIVER:]DATABASE ...]], --remove-database [[DRIVER:]DATABASE [[DRIVER:]DATABASE ...]]

Rimuove un database dal tenant, nella forma driver:nome

--enable

Abilita il tenant

--disable

Disabilita il tenant

.export

Esporta dati in un formato specifico. Uso:

.export -o <output> [-t <table>] [-c [<columns> [<columns> ...]]] [-w <where>] [-f] konga|csv|json|excel ...
konga

Konga

csv

Comma separated values (csv)

json

Javascript object notation (json)

excel

Microsoft™ excel

Argomenti opzionali:

-o <output>, --output <output>

Specifica il nome del file di destinazione

-t <table>, --table <table>

Aggiungi una tabella alla lista delle tabelle da esportare

-c [<columns> [<columns> ...]], --columns [<columns> [<columns> ...]]

Per la tabella corrente, aggiungi un campo alla lista di campi da esportare

-w <where>, --where <where>

Per la tabella corrente, specifica una espressione where sql come filtro

-f, --format

Specifica il formato di esportazione dati

  • Opzioni specifiche per csv:

    --header

    Includi nomi delle colonne come prima riga

    --flat-file

    Genera un singolo output per tutte le tabelle selezionate

    --multiple-files

    Spezza l’output in file multipli

    --max-size <max_size>

    Numero massimo di record per file

    --separator-type predefined|custom

    Carattere separatore predefinito

    --separator ;|,|tab
    --custom-separator <custom_separator>
    --encoding utf-8|latin1|mac_roman|latin2|ascii

    Codifica caratteri

    --export-auto

    Esporta i record generati automaticamente

    --notes

    Esporta le note associate ai record se presenti

  • Opzioni specifiche per json:

    --multiple-files

    Spezza l’output in file multipli

    --max-size <max_size>

    Numero massimo di record per file

    --encoding utf-8|latin1|mac_roman|latin2|ascii

    Codifica caratteri

    --export-auto

    Esporta i record generati automaticamente

    --notes

    Esporta le note associate ai record se presenti

    --images

    Esporta le immagini associate ai record se presenti (solo immagini interne al db)

  • Opzioni specifiche per excel:

    --file-format xls|xlsx

    Formato del file

    --header

    Includi nomi delle colonne come prima riga

    --flat-file

    Genera un singolo foglio di lavoro per tutte le tabelle selezionate

    --export-auto

    Esporta i record generati automaticamente

    --notes

    Esporta le note associate ai record se presenti

Avvertimento

Questo comando è disponibile solo dalla console dei comandi di Konga e Konga Client; non è disponibile nella console dei comandi di Konga Server Monitor.

.help

Mostra aiuto sul funzionamento della console. Uso:

.help [<command>]
command

Comando per cui visualizzare l’aiuto

.import

Importa dati da una sorgente esterna. Uso:

.import -i [<input> [<input> ...]] [-t <table>] [-c [<columns> [<columns> ...]]] [-u CODE] [-r OLD_CODE NEW_CODE] [--preserve] [--no-indexing] [-f] konga|csv|json|excel|tibet ...
konga

Konga

csv

Comma separated values (csv)

json

Javascript object notation (json)

excel

Microsoft™ excel

tibet

Tibet 1.7.x

Argomenti opzionali:

-i [<input> [<input> ...]], --input [<input> [<input> ...]]

Aggiungi un file sorgente alla lista di files da importare

-t <table>, --table <table>

Aggiungi una tabella alla lista delle tabelle da importare

-c [<columns> [<columns> ...]], --columns [<columns> [<columns> ...]]

Per la tabella corrente, aggiungi un campo alla lista di campi da importare

-u CODE, --update CODE

Preserva ed eventualmente aggiorna un’azienda durante l’importazione

-r OLD_CODE NEW_CODE, --rename OLD_CODE NEW_CODE

Rinomina il codice di un’azienda senza cancellarla prima dell’importazione

--preserve

Preserva i dati importati anche se ci sono errori

--no-indexing

Non indicizzare i dati importati

-f, --format

Specifica il formato di importazione dati

  • Opzioni specifiche per csv:

    --header

    Assumi che la prima riga contenga i nomi delle colonne

    --flat-file

    Assumi che i dati di tutte le tabelle siano presenti nello stesso input

    --separator-type predefined|custom

    Carattere separatore predefinito

    --separator ;|,|tab
    --custom-separator <custom_separator>
    --encoding utf-8|latin1|mac_roman|latin2|ascii

    Codifica caratteri

  • Opzioni specifiche per json:

    --encoding utf-8|latin1|mac_roman|latin2|ascii

    Codifica caratteri

  • Opzioni specifiche per excel:

    --header

    Assumi che la prima riga contenga i nomi delle colonne

    --flat-file

    Assumi che i dati di tutte le tabelle siano presenti nello stesso foglio di lavoro

Avvertimento

Questo comando è disponibile solo dalla console dei comandi di Konga e Konga Client; non è disponibile nella console dei comandi di Konga Server Monitor.

.index

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

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

Nome del database

Argomenti opzionali:

-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

.kill_client

Forza la disconnessione dal server della postazione specificata. Uso:

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

Id della postazione da disconnettere

Argomenti opzionali:

-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_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

.list_usb_devices

Ottiene la lista dei dispositivi USB attualmente connessi. Uso:

.list_usb_devices

.open_database

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

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

Nome del database

Argomenti opzionali:

-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

Argomenti opzionali:

-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

.pos

Controlla il misuratore fiscale corrente. Uso:

.pos display|begin|end|sell|return|discount|subtotal|pay|text|desc|footer|barcode|abort|inflow|outflow|drawer|balance ...
display

Mostra un messaggio sul display

begin

Apre un nuovo scontrino

end

Chiude lo scontrino corrente

sell

Esegue una vendita

return

Esegue una vendita

discount

Esegue uno sconto

subtotal

Stampa il subtotale corrente

pay

Stampa il subtotale corrente

text

Stampa una riga generica sullo scontrino

desc

Stampa una riga descrittiva nel corpo dello scontrino

Aggiunge una riga descrittiva a fine scontrino

barcode

Stampa un codice a barre

abort

Annulla lo scontrino corrente

inflow

Registra un’entrata di cassa

outflow

Registra un’uscita di cassa

drawer

Apre il cassetto del registratore di cassa

balance

Esegue una chiusura di cassa

  • Opzioni specifiche per display:

    text

    Testo da mostrare

  • Opzioni specifiche per begin:

    -o <operator>, --operator <operator>

    Imposta l’operatore di cassa per l’emissione del nuovo scontrino

    --non-fiscal

    Apre uno scontrino in modalità non fiscale

  • Opzioni specifiche per sell:

    desc

    Descrizione della vendita

    price

    Prezzo unitario

    -q <quantity>, --quantity <quantity>

    Descrizione della vendita

    -d <department>, --department <department>

    Reparto di vendita

  • Opzioni specifiche per return:

    desc

    Descrizione della vendita

    price

    Prezzo unitario

    quantity

    Descrizione della vendita

    -d <department>, --department <department>

    Reparto di vendita

  • Opzioni specifiche per discount:

    value

    Importo calcolato dello sconto

    -p <percentage>, --percentage <percentage>

    Percentuale di sconto

    --total

    Applica lo sconto al totale dello scontrino

  • Opzioni specifiche per pay:

    value

    Esegue un pagamento

    -t cash|checks|credit|vaucher|advance|card|ticket, --type cash|checks|credit|vaucher|advance|card|ticket

    Tipo di pagamento

    -n <number>, --number <number>

    Numero della carta/ticket da usare nel pagamento

  • Opzioni specifiche per text:

    text

    Testo da stampare

    -b, --bold

    Usa il carattere grassetto

    -d, --double

    Usa il carattere ad altezza doppia

  • Opzioni specifiche per desc:

    text

    Testo da stampare

  • Opzioni specifiche per footer:

    Testo da stampare

    Usa il carattere grassetto

    Usa il carattere ad altezza doppia

  • Opzioni specifiche per barcode:

    code

    Codice ean13 di cui stampare il codice a barre

  • Opzioni specifiche per inflow:

    value

    Ammontare dell’entrata di cassa

    -o <operator>, --operator <operator>

    Imposta l’operatore di cassa per l’operazione

    -d <desc>, --desc <desc>

    Descrizione dell’entrata di cassa

    -t cash|checks, --type cash|checks

    Tipo di entrata di cassa

  • Opzioni specifiche per outflow:

    value

    Ammontare dell’uscita di cassa

    -o <operator>, --operator <operator>

    Imposta l’operatore di cassa per l’operazione

    -d <desc>, --desc <desc>

    Descrizione dell’uscita di cassa

    -t cash|checks, --type cash|checks

    Tipo di uscita di cassa

  • Opzioni specifiche per drawer:

    -o <operator>, --operator <operator>

    Imposta l’operatore di cassa per l’operazione

  • Opzioni specifiche per balance:

    -o <operator>, --operator <operator>

    Imposta l’operatore di cassa per l’operazione

.preferences

Ottiene o imposta le preferenze del programma. Uso:

.preferences list|get|set|reset [<key>] ...
list|get|set|reset

Azione da eseguire

key

Percorso della preferenza da ottenere o impostare

value

Valore da impostare

.print

Esegue una stampa. Uso:

.print [-o pdf|csv|xls] [-f <filename>] [-y] [--list-commands] [--list-vars] [<command>] [name=value [name=value ...]]
command

Nome del comando di stampa nella forma «comando[:variante|titolo]»

name=value

Variabili predefinite da passare alla stampa

Argomenti opzionali:

-o pdf|csv|xls, --output pdf|csv|xls

Formato di output della stampa

-f <filename>, --filename <filename>

Nome e percorso del file di output

-y, --always-confirm

Conferma sempre qualsiasi operazione inerente alla stampa

--list-commands

Mostra la lista dei comandi di stampa disponibili

--list-vars

Mostra informazioni sulle variabili predefinite disponibili per la stampa

Avvertimento

Questo comando è disponibile solo dalla console dei comandi di Konga e Konga Client; non è disponibile nella console dei comandi di Konga Server Monitor.

.query

Esegue una query sul database attualmente connesso. Uso:

.query [-n] [--full-names] [--full-blobs] [--quiet] ...
sql

Query sql da eseguire

Argomenti opzionali:

-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.

--quiet

Sopprime la stampa dei risultati

.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

.repair

Prova a riparare un database danneggiato. Uso:

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

Nome del database danneggiato

Argomenti opzionali:

-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] <backup_name>
backup_name

Nome del backup

Argomenti opzionali:

-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 da cui leggere la lista dei backup

.rollback

Termina la transazione corrente tralasciando le modifiche. Uso:

.rollback [--index]

Argomenti opzionali:

--index

Riprendi l’indicizzazione del database se precedentemente sospesa

.send_message

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

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

Testo del messaggio

Argomenti opzionali:

-t [<target> [<target> ...]], --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

.set_data_language

Imposta la lingua dei dati. Uso:

.set_data_language it|en|nl|bg|cz|cn|hr|dk|ee|fi|fr|gr|ie|lv|lt|mt|pl|pt|ro|ru|sk|si|es|se|de|hu
it|en|nl|bg|cz|cn|hr|dk|ee|fi|fr|gr|ie|lv|lt|mt|pl|pt|ro|ru|sk|si|es|se|de|hu

Codice iso della nuova lingua da impostare

.time

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

.time ...
command

Comando o query da eseguire

.unlock_fields

Permetti di modificare i campi bloccati da lucchetto. Uso:

.unlock_fields [--disable]

Argomenti opzionali:

--disable

Disabilita la possibilità di modificare i campi bloccati da lucchetto

Avvertimento

Sbloccare i campi con lucchetto è un’operazione potenzialmente pericolosa in quanto consente di modificare dati sensibili che normalmente non andrebbero modificati. Usare con cautela.

.upgrade_database

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

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

Nome del database

Argomenti opzionali:

-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>] [<name>]
name

Nuovo nome utente

Argomenti opzionali:

-p <password>, --password <password>

Password di accesso per l’autenticazione dell’utente

.uuid

Genera uno o più UUID. Uso:

.uuid [<count>]
count

Numero di uuid da generare

.version

Riporta informazioni sulla versione. Uso:

.version