`$sql`

On this page

$sql processes an SQL query of the data in a collection. The $sql stage:

Use this stage for read-only queries.

Syntax

{
  $sql: {
    statement: "<SQL-statement>",
    excludeNamespaces: true | false
  }
}

Field	Type	Description	Necessity
`statement`	string	SQL query or command to run.	Required
`excludeNamespaces`	boolean	Flag that specifies whether to exclude the namespaces in the result set.	Optional

The following example shows the $sql syntax for querying a sampleDB.egData collection:

{
  $sql: {
    statement: "select * from egData limit 2",
    excludeNamespaces: true
  }
}

Back

Retrieve Query History

Limitations