UNDROP AGENT¶
Restores the most recent version of a dropped Cortex Agent.
- See also:
ALTER AGENT, CREATE AGENT, DESCRIBE AGENT, DROP AGENT, SHOW AGENTS
Syntax¶
Parameters¶
nameSpecifies the identifier for the Cortex Agent to restore.
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 or MODIFY | Agent that you restore | USAGE or MONITOR on the agent isn’t sufficient. |
| CREATE AGENT | Schema where you restore the agent | Required even if your role owns the agent. |
Operating on an object in a schema requires at least one privilege on the parent database and at least one privilege on the parent 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¶
- You can restore an agent only to the database and schema that contained it when it was dropped.
- If an agent with the same name already exists,
UNDROP AGENTreturns an error. - If the agent was dropped more than once,
UNDROP AGENTrestores the most recently dropped version. - You can’t restore a temporary agent.
- The restored agent keeps its specification, comment, versions,
aliases, live version,
SECUREsetting, privilege grants, and tags. - If the agent was added to the Snowflake CoWork object before it was dropped,
UNDROP AGENTdoesn’t add it back. To add the restored agent to the Snowflake CoWork object, runALTER SNOWFLAKE INTELLIGENCE ... ADD AGENT. For more information, see Snowflake CoWork object.
- UNDROP relies on the Snowflake Time Travel feature. An object can be restored only if the object was deleted within the Data retention period. The default value is 24 hours.
Examples¶
The following example restores the dropped agent named my_agent in the current schema:
The following example restores the dropped agent named my_agent in the mydb database and myschema schema: