Function: sql-help

sql-help is an interactive and byte-compiled function defined in sql.el.gz.

Signature

(sql-help)

Documentation

Show short help for the SQL modes.

Use an entry function to open an interactive SQL buffer. This buffer is usually named *SQL*. The name of the major mode is SQLi.

Use the following commands to start a specific SQL interpreter:

    MariaDB: M-x sql-mariadb (sql-mariadb)

    MySQL: M-x sql-mysql (sql-mysql)

    Postgres: M-x sql-postgres (sql-postgres)

    SQLite: M-x sql-sqlite (sql-sqlite)

Other non-free SQL implementations are also supported:

    DB2: M-x sql-db2 (sql-db2)

    Informix: M-x sql-informix (sql-informix)

    Ingres: M-x sql-ingres (sql-ingres)

    Interbase: M-x sql-interbase (sql-interbase)

    Linter: M-x sql-linter (sql-linter)

    Microsoft: M-x sql-ms (sql-ms)

    Oracle: M-x sql-oracle (sql-oracle)

    Solid: M-x sql-solid (sql-solid)

    Sybase: M-x sql-sybase (sql-sybase)

    Vertica: M-x sql-vertica (sql-vertica)

But we urge you to choose a free implementation instead of these.

You can also use M-x sql-product-interactive (sql-product-interactive) to invoke the interpreter for the current sql-product.

Once you have the SQLi buffer, you can enter SQL statements in the buffer. The output generated is appended to the buffer and a new prompt is generated. See the In/Out menu in the SQLi buffer for some functions that help you navigate through the buffer, the input history, etc.

If you have a really complex SQL statement or if you are writing a procedure, you can do this in a separate buffer. Put the new buffer in sql-mode by calling M-x sql-mode (sql-mode). The name of this buffer can be anything. The name of the major mode is SQL.

In this SQL buffer (SQL mode), you can send the region or the entire buffer to the interactive SQL buffer (SQLi mode). The results are appended to the SQLi buffer without disturbing your SQL buffer.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/sql.el.gz
(defun sql-help ()
  "Show short help for the SQL modes."
  (interactive)
  (describe-function 'sql-help))