PostgreSQL | PostgreSQL 기본 구성 | 주석(comment) 작성


PostgreSQL로 SQL을 작성 할 때 주석을 작성하는 방법에 대해 설명한다.

주석을 작성하는 방법

SQL 문을 작성할 때, 주석을 하고자하는 경우에는 하이픈을 두개 연속해서 작성(--) 한 곳에서 문장의 끝까지가 주석이다.

-- 한줄이 주석이다.

그리고, 여러 줄의 코멘트를 작성하려면 /*에서 */까지의 부분을 주석이다.

/* 여기에서부터 주석이다.
여러 줄의 주석이 가능하다.
*/

주석은 실행이 되면 완전히 무시가 되어서 psql을 커멘드 라인 기반에서 SQL 명령을 실행하면 주석 부분은 아무 의미가 없지만, 다른 파일에 SQL 명령을 작성 두었다가 파일을 로드하고 실행하는 경우 등에 사용할 수 있다.

그럼 실제로 해보도로 하자. 텍스트 편집기를 열고 다음과 같이 작성한다.

/*
테이블 생성 및 데이터 추가
2020/10/26
*/

-- 테이블 만들기
create table friends (id integer, name varchar (10));

-- 데이터 추가
insert into friends values (1, 'kimkc');
insert into friends values (2, 'hwang.yh');
insert into friends values (5, 'lim.yt');

작성한 파일을 이번에는 test.sql라는 이름으로 c:\dev 디렉토리에 저장한다.

현재 psql의 문자 코드를 확인하면 UHC로 되어 있으므로, 파일 문자 코드은 EUC_KR로 저장한다.

postgres=# \encoding
UHC
postgres=# 

그러면 psql을 사용하여 PostgreSQL의 mydb 데이터베이스에 연결한다.

C:\Users\kimkc>psql -U postgres -d mydb
postgres 사용자의 암호:
psql (12.2)
도움말을 보려면 "help"를 입력하십시오.

mydb=#

저장된 파일을 로드하고 실행하려면 psql 명령어로 \i를 사용하여 다음과 같이 실행한다.

mydb=# \i c:/dev/test.sql
CREATE TABLE
INSERT 0 1
INSERT 0 1
INSERT 0 1
mydb=#

파일에 작성한 코멘트 부분은 무시되고 그 이외의 부분이 성공적으로 실행되었다. 확인을 위해 psql에서 다음과 같이 SQL 명령을 실행해 본다.

mydb=# select * from friends;
 id |   name
----+----------
  1 | kimkc
  2 | hwang.yh
  5 | lim.yt
(3개 행)

테이블에 작성되어 있고, 데이터가 3건 추가되어 있는 것을 확인할 수 있다.

여기까지 PostgreSQL로 주석을 작성하는 방법에 대해 설명하였다.