SHOW EXTERNAL AGENTS

SHOW EXTERNAL AGENTS

SHOW EXTERNAL AGENTS 명령은 접근 권한(privilege)이 있는 외부 에이전트(external agent) 목록을 보여주는 명령이에요. 외부 에이전트는 AI Observability와 함께 사용하기 위해 Snowflake의 생성형 AI 애플리케이션을 나타내요.

출처: 문서

본문

이 명령은 접근 권한이 있는 외부 에이전트를 나열해요. 출력은 데이터베이스, 스키마, 외부 에이전트 이름 기준 사전 순으로 정렬된 객체 메타데이터와 속성을 반환해요.

관련 명령: CREATE EXTERNAL AGENT, ALTER EXTERNAL AGENT, DROP EXTERNAL AGENT, DESCRIBE EXTERNAL AGENT.

구문 (Syntax)

SHOW EXTERNAL AGENTS [ LIKE '<pattern>' ]
                     [ IN { ACCOUNT | DATABASE [ <db_name> ] | SCHEMA [ <schema_name> ] } ]

파라미터 (Parameters)

  • LIKE <pattern> — 명령 출력을 객체 이름으로 필터링해요. 대소문자를 구분하지 않는 패턴 매칭이며 SQL 와일드카드 문자(%와 _)를 지원해요. 기본값: 없음.

  • IN { ACCOUNT | DATABASE [ <db_name> ] | SCHEMA [ <schema_name> ] } — 명령의 범위를 지정해요:

    • ACCOUNT — 현재 계정의 모든 데이터베이스·스키마 레코드 반환.
    • DATABASE — 지정한 데이터베이스 또는 현재 데이터베이스의 모든 스키마 레코드 반환.
    • SCHEMA — 현재 또는 지정한 스키마의 레코드 반환.
    • 기본값: 세션에 현재 데이터베이스가 있는지에 따라 달라져요. 데이터베이스 있으면 현재 데이터베이스의 외부 에이전트(범위는 DATABASE), 없으면 계정 범위(ACCOUNT)가 기본.

출력 (Output)

명령 출력은 외부 에이전트 속성과 메타데이터를 다음 컬럼으로 제공해요:

  • created_on — 외부 에이전트가 생성된 타임스탬프.
  • name — 외부 에이전트 이름.
  • database_name — 외부 에이전트가 있는 데이터베이스.
  • schema_name — 외부 에이전트가 있는 스키마.
  • owner — 외부 에이전트를 소유한 역할.
  • comment — 외부 에이전트에 대한 주석.
  • versions — 외부 에이전트의 버전을 나열하는 JSON 배열.
  • default_version_name — 외부 에이전트의 기본 버전.

접근 제어 요구 사항 (Access control requirements)

이 SQL 명령을 실행하는 역할은 최소한 다음 권한 중 하나를 가져야 해요:

권한 (Privilege) 객체 (Object) 비고
OWNERSHIP, USAGE 중 하나 외부 에이전트

스키마의 객체를 조작하려면 상위 데이터베이스에 최소 하나, 상위 스키마에 최소 하나의 권한이 필요해요.

사용 참고 사항 (Usage notes)

  • 실행에 실행 중인 웨어하우스를 요구하지 않아요.
  • 현재 역할에 하나 이상의 접근 권한이 부여된 객체만 반환해요.
  • MANAGE GRANTS 권한은 보유자가 계정의 모든 객체를 볼 수 있게 해줘요. 기본적으로 ACCOUNTADMIN과 SECURITYADMIN 역할만 이 권한을 가져요.
  • 출력을 후처리하려면 파이프 연산자(|>) 또는 RESULT_SCAN 함수를 사용할 수 있어요. 출력 컬럼을 참조할 때는 컬럼 이름을 큰따옴표로 감싸서 사용해요.

예제 (Examples)

현재 스키마의 모든 외부 에이전트를 나열해요:

SHOW EXTERNAL AGENTS;

특정 스키마의 외부 에이전트를 나열해요:

SHOW EXTERNAL AGENTS IN SCHEMA mydb.myschema;

특정 데이터베이스의 외부 에이전트를 나열해요:

SHOW EXTERNAL AGENTS IN DATABASE mydb;

계정의 모든 외부 에이전트를 나열해요:

SHOW EXTERNAL AGENTS IN ACCOUNT;

이름이 my_rag로 시작하는 외부 에이전트를 나열해요:

SHOW EXTERNAL AGENTS LIKE 'my_rag%';

더 알아보기 (Learn more)