함수 참조

함수 참조 (Function reference)

aws_s3 및 aws_commons 확장이 제공하는 함수들의 참조 정보를 정리한 페이지예요. S3에서 데이터를 가져올 때 사용하는 함수들 하나씩 설명할게요.

출처: 문서

본문

함수 (Functions)

aws_s3.table_import_from_s3
aws_commons.create_s3_uri
aws_commons.create_aws_credentials

aws_s3.table_import_from_s3

Amazon S3 데이터를 Amazon RDS 테이블로 가져와요. aws_s3 확장이 aws_s3.table_import_from_s3 함수를 제공해요. 반환 값은 텍스트(text)예요.

구문 (Syntax)

필수 매개변수는 table_name, column_list, options예요. 이들은 데이터베이스 테이블을 식별하고 데이터가 테이블에 어떻게 복사되는지 지정해요.

다음 매개변수도 사용할 수 있어요.

s3_info 매개변수는 가져올 Amazon S3 파일을 지정해요. 이 매개변수를 사용하면 PostgreSQL DB 인스턴스의 IAM 역할이 Amazon S3에 대한 접근을 제공해요.

aws_s3.table_import_from_s3 (
   table_name text,
   column_list text,
   options text,
   s3_info aws_commons._s3_uri_1
)

credentials 매개변수는 Amazon S3에 접근하기 위한 자격 증명을 지정해요. 이 매개변수를 사용하면 IAM 역할을 사용하지 않아요.

aws_s3.table_import_from_s3 (
   table_name text,
   column_list text,
   options text,
   s3_info aws_commons._s3_uri_1,
   credentials aws_commons._aws_credentials_1
)

매개변수 (Parameters)

table_name – 데이터를 가져올 PostgreSQL 데이터베이스 테이블의 이름을 담은 필수 텍스트 문자열이에요.
column_list – 데이터를 복사할 PostgreSQL 데이터베이스 테이블 열의 선택적 목록을 담은 필수 텍스트 문자열이에요. 문자열이 비어 있으면 테이블의 모든 열이 사용돼요. 예시는 "사용자 지정 구분 기호를 사용하는 Amazon S3 파일 가져오기" 문서를 참고하세요.
options – PostgreSQL COPY 명령의 인자를 담은 필수 텍스트 문자열이에요. 이 인자는 데이터가 PostgreSQL 테이블에 어떻게 복사되는지 지정해요. 자세한 내용은 PostgreSQL COPY 문서를 참고하세요.
s3_info – S3 객체에 대한 다음 정보를 포함하는 aws_commons._s3_uri_1 복합 유형이에요.
- bucket – 파일이 들어 있는 Amazon S3 버킷의 이름이에요.
- file_path – 파일 경로를 포함한 Amazon S3 파일 이름이에요.
- region – 파일이 있는 AWS 리전이에요. AWS 리전 이름과 관련 값 목록은 "Regions, Availability Zones, and Local Zones" 문서를 참고하세요.
credentials – 가져오기 작업에 사용할 다음 자격 증명을 포함하는 aws_commons._aws_credentials_1 복합 유형이에요.
- Access key (액세스 키)
- Secret key (시크릿 키)
- Session token (세션 토큰)
aws_commons._aws_credentials_1 복합 구조체 생성 방법은 aws_commons.create_aws_credentials 문서를 참고하세요.

대체 구문 (Alternate syntax)

테스트를 돕기 위해 s3_info와 credentials 매개변수 대신 확장된 매개변수 집합을 사용할 수 있어요. aws_s3.table_import_from_s3 함수의 추가 구문 변형은 다음과 같아요.

Amazon S3 파일을 식별하기 위해 s3_info 매개변수 대신 bucket, file_path, region 매개변수의 조합을 사용해요. 이 함수 형식을 사용하면 PostgreSQL DB 인스턴스의 IAM 역할이 Amazon S3에 대한 접근을 제공해요.

aws_s3.table_import_from_s3 (
   table_name text,
   column_list text,
   options text,
   bucket text,
   file_path text,
   region text
)

Amazon S3 접근을 지정하기 위해 credentials 매개변수 대신 access_key, secret_key, session_token 매개변수의 조합을 사용해요.

aws_s3.table_import_from_s3 (
   table_name text,
   column_list text,
   options text,
   bucket text,
   file_path text,
   region text,
   access_key text,
   secret_key text,
   session_token text
)

대체 매개변수 (Alternate parameters)

bucket – 파일이 들어 있는 Amazon S3 버킷의 이름을 담은 텍스트 문자열이에요.
file_path – 파일 경로를 포함한 Amazon S3 파일 이름을 담은 텍스트 문자열이에요.
region – 파일의 AWS 리전 위치를 식별하는 텍스트 문자열이에요. AWS 리전 이름과 관련 값 목록은 "Regions, Availability Zones, and Local Zones" 문서를 참고하세요.
access_key – 가져오기 작업에 사용할 액세스 키를 담은 텍스트 문자열이에요. 기본값은 NULL이에요.
secret_key – 가져오기 작업에 사용할 시크릿 키를 담은 텍스트 문자열이에요. 기본값은 NULL이에요.
session_token – (선택 사항) 가져오기 작업에 사용할 세션 토큰을 담은 텍스트 문자열이에요. 기본값은 NULL이에요.

aws_commons.create_s3_uri

Amazon S3 파일 정보를 담기 위한 aws_commons._s3_uri_1 구조체를 생성해요. aws_commons.create_s3_uri 함수의 결과를 aws_s3.table_import_from_s3 함수의 s3_info 매개변수에 사용해요.

구문 (Syntax)

aws_commons.create_s3_uri(
   bucket text,
   file_path text,
   region text
)

매개변수 (Parameters)

bucket – 파일에 대한 Amazon S3 버킷 이름을 담은 필수 텍스트 문자열이에요.
file_path – 파일 경로를 포함한 Amazon S3 파일 이름을 담은 필수 텍스트 문자열이에요.
region – 파일이 있는 AWS 리전을 담은 필수 텍스트 문자열이에요. AWS 리전 이름과 관련 값 목록은 "Regions, Availability Zones, and Local Zones" 문서를 참고하세요.

aws_commons.create_aws_credentials

aws_commons._aws_credentials_1 구조체에 액세스 키와 시크릿 키를 설정해요. aws_commons.create_aws_credentials 함수의 결과를 aws_s3.table_import_from_s3 함수의 credentials 매개변수에 사용해요.

구문 (Syntax)

aws_commons.create_aws_credentials(
   access_key text,
   secret_key text,
   session_token text
)

매개변수 (Parameters)

access_key – Amazon S3 파일 가져오기에 사용할 액세스 키를 담은 필수 텍스트 문자열이에요. 기본값은 NULL이에요.
secret_key – Amazon S3 파일 가져오기에 사용할 시크릿 키를 담은 필수 텍스트 문자열이에요. 기본값은 NULL이에요.
session_token – Amazon S3 파일 가져오기에 사용할 세션 토큰을 담은 선택적 텍스트 문자열이에요. 기본값은 NULL이에요. 선택적 session_token을 제공하면 임시 자격 증명을 사용할 수 있어요.

더 알아보기 (Learn more)

공식 문서