PostgreSQL의 주석 문자

Bilal Shahid 2023년6월20일
  1. PostgreSQL의 기본 주석
  2. PSQL의 주석 - PostgreSQL 명령줄 유틸리티
  3. PostgreSQL의 특정 개체에 대한 ‘COMMENT’
PostgreSQL의 주석 문자

이 기사에서는 PostgreSQL에서 문자 또는 문자 집합에 대해 설명하는 방법을 소개합니다.

많은 언어에서는 프로그래머가 특정 코드나 코드의 특정 부분이 어떻게 작동하는지 설명하는 방법으로 주석을 사용합니다.

그 뒤에는 대부분 기호가 오고 그 다음 파서에서 주석으로 인식되는 전체 행이 옵니다. PostgreSQL에서는 -- 키워드와 특정 주석을 사용하여 주석을 달았습니다.

PostgreSQL의 기본 주석

Postgres 쿼리의 항목에 대해 설명하려면 코드에 다음 구문을 사용하십시오.

-- [comment string] (STANDARD SQL SINGLE LINE)
or
/* [comment string
    comment string 2] */ (STANDARD SQL MULTI LINE CODE)

주석은 쿼리 실행에 불필요한 것으로 간주되므로 추가 구문 분석이 수행되기 전에 제거됩니다.

따라서 무언가에 대해 언급하려면 쿼리로 이동하여 다음과 같이 수행하십시오.

-- This is a test comment

그리고 이와 같은 방식으로 코드를 실행하는 경우 문자가 주석의 일부이므로 코드가 여전히 올바르게 실행되고 코드 구문에 간섭하지 않습니다. 더 큰 주석 문자열을 사용하여 여러 줄에서 동일한 작업을 수행하려면 다음과 같이 작성하십시오.

/*
I am working on a test string
that is effectively better
with multiple lines
*/

따라서 PostgreSQL에서 COMMENT하는 것이 얼마나 쉬운지 알 수 있습니다. 그러나 이 방법론은 PGADMIN[Version_NO] 또는 PostgreSQL을 실행할 수 있는 다른 GUI에 대해 완벽하게 작동합니다.

명령줄 유틸리티 또는 bash를 참조하는 경우 몇 가지 사항을 염두에 두어야 합니다. 그들이 아래에 무엇인지 보자.

PSQL의 주석 - PostgreSQL 명령줄 유틸리티

PSQL을 부팅하고 PGADMIN에서 했던 것처럼 댓글을 작성해 봅시다.

select  * from DOGGY; --postgres

위 쿼리를 실행하면 올바른 결과가 반환됩니다. 그러나 \ 명령으로 동일한 작업을 수행하려고 하면 어떻게 됩니까? 다음 쿼리를 실행합니다.

\dt --display relations

출력:

Did not find any relation named "--display".
\dt: extra argument "relations" ignored

DT 명령의 경우만 그런 것이 아닙니다. SLASH를 포함하는 PSQL에서 다른 쿼리를 실행하면 주석이 무시될 수 있습니다.

따라서 이 문제를 해결하기 위해 PostgreSQL의 쿼리 옆에 주석을 작성하는 대신 COMMENT를 가져와 SLASH 명령 전에 실행할 수 있습니다. 이러한 방식으로 주석이 무시되지는 않지만 작업 코드의 깨끗한 버전을 구현할 수도 있습니다.

postgres=# --postgres
postgres=# \dt

위의 명령을 실행하면 이제 원하는 결과를 얻을 수 있습니다. 또한 더 이상 IGNORE 오류가 발생하지 않습니다.

위 명령은 \DT 앞에 -- POSTGRES를 추가한 다음 실행하면 됩니다.

PSQLSLASH 명령은 META-COMMANDS라고도 합니다. 이제 PSQL에 주석을 추가하는 다양한 다른 방법을 살펴보겠습니다.

\ECHO를 사용하여 PSQL에서 주석 처리

다음 쿼리를 실행하면 완벽하게 작동하는 경향이 있습니다.

\dt \echo display table

그리고 다음 결과를 표시합니다.

에코 주석

PSQL\ECHOOUTPUT에 대한 인수를 인쇄하는 경향이 있습니다. 따라서 \ECHO 옆에 주석을 작성하면 콘솔에 해당 주석이 인쇄됩니다.

따라서 PSQL에 주석을 추가하는 아름다운 방법입니다.

주석을 달기 위해 PSQL에서 \ECHO 명령의 대안으로 \WARN을 사용하십시오.

콘솔에서 주석을 인쇄할 수 있는 또 다른 명령은 \WARN입니다. \ECHO와 유사합니다. 그러나 출력은 표준 오류 채널에 인쇄됩니다.

이것은 차이를 만들지 않습니다. \WARN 명령으로 쿼리를 실행하면 완벽하게 작동합니다.

\dt \warn display_table;

PSQL의 표준 오류 채널은 콘솔이기 때문에 \ECHO 옆의 모든 주석은 이전 명령 실행 직후에 인쇄됩니다.

\--를 사용하여 PSQL에서 주석 처리

\dt \\ --display_table_check

위의 쿼리는 테이블을 반환하지만 콘솔에 주석을 출력하지 않습니다. \\SEPARATOR 메타 명령이며 이를 충족하는 두 개의 서로 다른 끝이 어떤 시나리오에서도 결합되지 않도록 지정하는 데 사용됩니다.

우리의 경우 \dt-- comment와 완전히 별개의 명령이며 \\를 지정하지 않은 PSQL은 둘 다 하나의 명령이라고 가정했을 수 있습니다.

PSQLPGADMIN에서 주석 처리하는 방법을 배웠으므로 여전히 탐색할 수 있는 몇 가지 다른 옵션이 있습니다. 필요와 원함.

PostgreSQL의 특정 개체에 대한 ‘COMMENT’

COMMENT 키워드는 PostgreSQL 데이터베이스의 특정 개체에 대해 설명하는 또 다른 효율적인 방법입니다. 여기 COMMENT에서 읽을 수 있습니다: URL.

지금은 TABLE의 예를 사용하고 이를 사용하여 주석을 달겠습니다.

COMMENT on table DOGGY is 'The Dogs table is amazing!';

그런 다음 이 주석을 보려면 PSQL로 전환하고 명령을 실행하십시오. \d+. 그러면 DESCRIPTION 열에서 주석을 볼 수 있는 테이블이 반환됩니다.

따라서 PSQL에서 쿼리를 실행하면 다음과 같은 결과를 얻을 수 있습니다.

출력:

댓글 키워드

따라서 COMMENT를 사용하면 구문 오류를 피하는 데 도움이 되며 주석을 간단하고 효과적이며 구체적으로 유지하는 효율적인 방법이기도 합니다.

그래서 오늘 우리는 PostgreSQL 세션에서 주석을 다는 방법을 배웠습니다. 물론 시나리오마다 다른 방법이 필요합니다.

예를 들어 COMMENT를 사용하는 것은 다른 프로그래머가 “객체를 생성한 코드의 작업"이 아니라 객체에 대한 설명과 자세한 설명을 확인해야 하는 경우 많은 도움이 될 것입니다. 따라서 어떤 방법을 선택하는지는 귀하에게 달려 있습니다.

항상 그렇듯이 코드의 기능을 더 잘 이해하려면 자습서를 올바르게 읽으십시오.

작가: Bilal Shahid
Bilal Shahid avatar Bilal Shahid avatar

Hello, I am Bilal, a research enthusiast who tends to break and make code from scratch. I dwell deep into the latest issues faced by the developer community and provide answers and different solutions. Apart from that, I am just another normal developer with a laptop, a mug of coffee, some biscuits and a thick spectacle!

GitHub