DROP AGENT

Removes the specified Cortex Agent with the specified name from the current or specified database and schema.

See also:

CREATE AGENT, DESCRIBE AGENT, SHOW AGENTS

Syntax

DROP AGENT [ IF EXISTS ] <name>
Copy

Parameters

name

Specifies the identifier for the Cortex Agent to be dropped.

If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

For more information, see Identifier requirements.

Access control requirements

A role used to execute this operation must have the following privileges at a minimum:

Privilege

Object

Notes

OWNERSHIP

Agent

MODIFY

Agent

The USAGE privilege on the parent database and schema are required to perform operations on any object in a schema. Note that a role granted any privilege on a schema allows that role to resolve the schema. For example, a role granted CREATE privilege on a schema can create objects on that schema without also having USAGE granted on that schema.

For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.

Usage notes

  • When the IF EXISTS clause is specified and the target object doesn’t exist, the command completes successfully without returning an error.

Examples

The following example drops the agent named my_agent in the current schema:

DROP AGENT my_agent;
Copy

The following example drops the agent named my_agent in the mydb database and myschema schema. This command fails if the agent does not exist:

DROP AGENT mydb.myschema.my_agent;
Copy

The following example drops the agent named my_agent in the mydb database and myschema schema only if it exists:

DROP AGENT IF EXISTS mydb.myschema.my_agent;
Copy
Language: English