[Go] Query Parameter를 이용해 PostgreSQL json 타입의 데이터 조회하기

7 분 소요

회사에서 Go와 PostgreSQL을 이용해 인증, 인가를 담당하는 Account 서버를 개발하던 중, jsonb 타입의 데이터를 조회하며 겪은 문제에 대해 기록하고자 한다.

상황

Account 서버에서는 사용자 계정을 관리하기 위해 users 테이블을 사용한다. 해당 테이블에서 관리하는 데이터 중 하나는 사용자 별 로그인이 허용된 스케쥴로, 다음과 같은 형태의 json 데이터를 jsonb 타입의 값으로 저장한다.

{
	"Sun": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
	"Mon": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
	"Tue": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
	"Wed": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
	"Thu": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
	"Fri": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
	"Sat": [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
}

key: 각 요일별 abbreviation
value: 시간대 별 user 로그인 허용 여부를 나타내는 길이 24의 배열
- 0: 로그인이 허용되어 있지 않음
- 1: 로그인이 허용되어 있음

SELECT * FROM users;

users-table-select-result

위와 같은 테이블을 이용해 현재 시각 기준 로그인이 허용되어 있지 않은 사용자를 차단하는 기능을 구현하고자 했다. 이를 위해서는 우선 users 테이블에서 현재 시각 기준 로그인이 허용되어 있지 않은 사용자를 조회해야 한다.

이는 다음과 같은 과정으로 이루어진다.

조회하고자 하는 요일과 시간대를 설정한 후,
schedule 컬럼에 저장된 json object에서 요일에 해당하는 배열을 찾아, 시간대 인덱스에 있는 값을 가져 온다.

예컨대, 현재 시각이 금요일 오전 9시 30분이고, 위 사진 기준 testuser1의 로그인이 허용되어 있는지 확인하기 위해서는 다음과 같은 쿼리를 사용하면 된다.

SELECT (schedule -> 'Fri' -> 9) AS login_allowed
FROM users
WHERE username='testuser1';

users-login-allowed-result

쿼리를 위해 PostgreSQL에서 jsonb 타입의 값에 사용할 수 있는 연산자 중 하나인 ->를 이용했다. 해당 연산자는 아래와 같이 동작한다.

피연산자의 타입이 text일 경우, 피연산자를 key로, 값에서 key에 해당하는 json object 필드를 반환한다.
- schedule 컬럼의 jsonb 값에서 Fri에 해당하는 key의 값을 가져온다. 따라서 길이가 24인 json array가 반환된다.
피연산자의 타입이 integer일 경우, 피연산자를 index로, 값에서 index에 해당하는 json array 필드를 반환한다.
- 길이가 24인 json array에서 index 9에 해당하는 값을 가져 온다. 따라서 0이 반환된다.

jsonb 타입에 대해 사용할 수 있는 PostgreSQL 연산자 및 내장 함수는 https://www.postgresql.org/docs/9.5/functions-json.html를 참고하면 확인할 수 있다.

다만, 위의 쿼리로 반환된 0이라는 값이 integer가 아님에 주의해야 한다(실제 첨부한 결과 사진에서도 쿼리 결과 값의 타입이 integer가 아니라 jsonb임을 확인할 수 있다). PostgreSQL에서 jsonb 타입은 INSERT 수행 당시의 text 값을 그대로 저장하기 때문에, 반환된 jsonb 타입을 활용하기 위해서는 형변환이 필요할 수 있다.

위의 과정을 이용해 전체 테이블에서 현재 시각 기준 로그인이 허용되어 있지 않은 사용자를 조회하기 위해서는 아래와 같이 쿼리를 작성하면 된다.

SELECT id, username, schedule
FROM users
WHERE schedule -> 'Fri' -> 9 = '0'; -- text와 비교

SELECT id, username, schedule
FROM users
WHERE (schedule -> 'Fri' -> 9)::int = 0; -- schedule 값을 integer로 형변환한 후, 0과 비교

SELECT id, username, schedule
FROM users
WHERE (schedule -> 'Fri' -> 9)::int = false::int; -- 의미를 명확히 하기 위해, false를 0으로 형변환하여 비교

users-select-result-2

상술한 내용에 따라, 아래와 같이 쿼리를 작성하면 WHERE 절에서 jsonb 타입과 integer 타입을 비교할 수 없기 때문에, 에러가 발생한다.

SELECT id, username, is_blocked, schedule
FROM users
WHERE schedule -> 'Fri' -> 9 = 0; -- jsonb 타입과 integer 타입의 비교

jsonb-integer-comparison-error

문제는 Go에서 PostgreSQL 데이터베이스를 연동해 로그인이 허용되어 있지 않은 사용자를 조회하는 코드를 작성했을 때 발생했다. Go에서 같은 기능을 하는 코드를 작성하고, 테스트 코드를 실행했다.

// 현재 시각에 로그인이 허용되지 않은 user 조회
func (p *PostgresRepository) GetUsersByIsBlockedTrueOrCurrentScheduleFalse() ([]*iface.User, error) {
	ctx, cancel := context.WithTimeout(context.Background(), QUERY_TIMEOUT)
	defer cancel()

	query := `
	SELECT
		username,
		is_blocked
	FROM
		users
	WHERE
		(schedule -> $1 -> $2)::int = 0
	`
	logger.Info("query: %s", query)

	now := time.Now()
	rows, err := p.db.QueryContext(ctx, query, p.convertWeekdayToAbbreviation(now.Weekday()), now.Hour())
	if err != nil {
		logger.Error("failed to query: %v", err)
		return nil, err
	}

	var users []*iface.User = make([]*iface.User, 0)
	for rows.Next() {
		var user iface.User
		err = rows.Scan(
			&user.Username,
			&user.IsBlocked,
		)
		if err != nil {
			logger.Error("failed to scan user: %v", err)
			return nil, err
		}
		users = append(users, &user)
	}
	logger.Debug("found %d users whose current schedule is 0", len(users))

	return users, nil
}

// 요일별 abbreviation을 구하기 위한 util 함수
func (p *PostgresRepository) convertWeekdayToAbbreviation(weekday time.Weekday) string {
	switch weekday {
	case time.Sunday:
		return "Sun"
	case time.Monday:
		return "Mon"
	case time.Tuesday:
		return "Tue"
	case time.Wednesday:
		return "Wed"
	case time.Thursday:
		return "Thu"
	case time.Friday:
		return "Fri"
	case time.Saturday:
		return "Sat"
	default:
		return ""
	}
}

PostgreSQL client를 이용해서 실행 후 의도된 대로 작동함을 확인했던 위의 쿼리에서, 요일과 시간대만 Query Parameter로 넘기도록 했다. 테스트 코드 실행 결과, 테이블 스키마와 테이블에 들어 있는 테스트 데이터가 모두 동일한 상태였는데도 불구하고, 아무런 레코드도 조회되지 않았다.

var dsn string = "your dsn"

func TestGetUsersByIsBlockedTrueOrCurrentScheduleFalse(t *testing.T) {
	r := require.New(t)
	p := pgrepo.New(dsn)
	users, err := p.GetUsersByIsBlockedTrueOrCurrentScheduleFalse()
	r.NoError(err)
	for _, user := range users {
		fmt.Printf("found user: %v\n", user.Username)
	}
}

go-query-parameter-no-result

분석

PostgreSQL 데이터베이스에 연동 후 쿼리를 수행할 때, Query Parameter가 문자열 타입으로 처리되며 발생한 문제였다.

PostgreSQL 연동을 위해 사용한 pq 패키지의 공식 문서 쿼리 부분을 참고하면, pq 라이브러리는 쿼리 매개변수 표현을 위해 PostgreSQL 기본 형식을 따른다.

database/sql does not dictate any specific format for parameter markers in query strings, and pq uses the Postgres-native ordinal markers, as shown above.

PostgreSQL에서는 쿼리 매개변수의 형식을 명시적으로 지정하지 않는 경우, 문자열 타입으로 처리한다. 따라서 문제가 되었던 위의 상황에서,

hour 변수에 저장된 값이 문자열로 변환되어 처리되고,

rows, err := p.db.QueryContext(ctx, query, p.convertWeekdayToAbbreviation(now.Weekday()), now.Hour()) 
// now.Hour()가 integer로 처리되지 않는다

now.Weekday()를 변환한 abbreviation이 text 타입으로 넘어 왔기 때문에, -> 연산자 정의에 의해 PostgreSQL은 schedule 컬럼에서 요일에 해당하는 json object를 찾은 후,
hour 변수에 저장된 값 역시 text 타입으로 넘어 왔기 때문에, -> 연산자 정의에 의해 해당 값을 키로 갖는 json object를 찾으려 하는데,
~~당연히~~ 해당하는 값이 없어 아무런 레코드도 조회할 수 없는 것이다.

물론 쿼리 매개변수가 사용되는 연산자나 함수의 문맥에 따라, 문자열이 아니라 다른 타입으로 처리되어야 하는 경우에는 PostgreSQL 자체에서 매개변수의 형변환을 진행해 주는 것 같다.

예컨대, 비슷한 경우인데 아래와 같은 코드를 실행하는 경우, 쿼리 매개 변수로 사용된 5는text가 아니라 integer 값으로 처리된다.

query := `
SELECT
	user_refresh_token_id,
	last_authenticated_at
FROM
	user_session
WHERE
	NOW()- last_authenticated_at >= INTERVAL '1 second' * $1;
`
logger.Trace("query: %s", query)

rows, err := p.db.QueryContext(ctx, query, 5) // $1 자리에 전달되는 쿼리 매개변수 값 5
if err != nil {
	logger.Error("failed to get user sessions by inactive duration: %v", err)
	return nil, err
}

조금 더 명확히 하기 위해, users 테이블에 아래와 같이 더미 데이터를 넣는다.

INSERT INTO users (username, is_blocked, schedule)
VALUES
	('test2', false, '{"Fri":{"1":0,"2":0,"3":0,"4":0,"5":0,"6":0,"7":0,"8":0,"9":0}}'),
	('test3', false, '{"Fri":{"1":0,"2":0,"3":0,"4":0,"5":0,"6":0,"7":0,"8":0,"9":0}}')
ON CONFLICT (username)
	DO UPDATE SET schedule=EXCLUDED.schedule;

dummy-schedule-test-data

그리고 동일한 코드로 테스트를 수행한다. 위와 달리, 2개의 레코드를 조회해 오는 것을 확인할 수 있다.

test-with-string-key

해결

문제가 된 코드의 쿼리 부분에서 사용된 Query Parameter의 값을 아래와 같이 integer 타입으로 형변환함으로써 문제 상황을 해결했다.

Query Parameter를 형변환함으로써 ->의 피연산자가 integer 타입으로 넘어 왔기 때문에,
PostgreSQL은 schedule 컬럼에서 요일에 해당하는 json object를 찾은 후,
hour 인덱스에 해당하는 element를 찾는다.

func (p *PostgresRepository) GetUsersByIsBlockedTrueOrCurrentScheduleFalse() ([]*iface.User, error) {
	ctx, cancel := context.WithTimeout(context.Background(), QUERY_TIMEOUT)
	defer cancel()

	// convert $2 to integer type
	query := `
	SELECT
		username,
		is_blocked
	FROM
		users
	WHERE
		(schedule -> $1 -> $2::int)::int = 0
	`
	logger.Info("query: %s", query)

	now := time.Now()
	rows, err := p.db.QueryContext(ctx, query, p.convertWeekdayToAbbreviation(now.Weekday()), now.Hour())
	if err != nil {
		logger.Error("failed to query: %v", err)
		return nil, err
	}

	var users []*iface.User = make([]*iface.User, 0)
	for rows.Next() {
		var user iface.User
		err = rows.Scan(
			&user.Username,
			&user.IsBlocked,
		)
		if err != nil {
			logger.Error("failed to scan user: %v", err)
			return nil, err
		}
		users = append(users, &user)
	}
	logger.Debug("found %d users whose current schedule is 0", len(users))

	return users, nil
}

jsonb-integer-success

결론

Backend 개발은 거의 모든 부분에서 데이터베이스와 연관되어 있다고 해도 과언이 아니다. 데이터베이스에 도메인 데이터를 저장하고, 이를 가공하는 일이 업무의 주를 차지하곤 한다.

그럼에도 불구하고 개인적으로 프로그래밍 언어, 백엔드 개발 프레임워크 등에 비해 데이터베이스를 주의 깊게 학습하지는 않d았다. ORM 기술을 이용하면 쿼리를 작성할 일이 그렇게 많지 않기도 하고, 직접 쿼리를 작성해 개발한다고 하더라도 간단한 SQL을 이용해 처리할 수 있는 경우가 대부분이기 때문이다. 물론 테이블 설계, 테이블 간 조인 등에 대해서는 고민할 기회가 종종 있으나, DBMS에서 지원하는 데이터 타입, 내장함수, DBMS 연동 등에 대해서는 크게 살펴보지 않았던 것이 사실이다.

그런 의미에서 이번 경험은 PostgreSQL에서 지원하는 jsonb 타입, PostgreSQL의 쿼리 매개변수 처리 방법 등에 대해 공부할 수 있는 좋은 기회였다. 당연히 되겠거니 하고 관성적으로 쿼리를 작성해 왔는데, 여기서 더 나아가 해당 쿼리가 동작하는 과정, 데이터 타입, 내장함수 등 DBMS의 관련 구현이 어떻게 되는지에 대해서도 살펴 보려는 습관을 들일 필요가 있다.

Twitter Facebook LinkedIn

이레이저

[Go] Query Parameter를 이용해 PostgreSQL json 타입의 데이터 조회하기

상황

분석

해결

결론

공유하기

댓글남기기

참고

[AWS] Github Actions를 이용해 Elastic Beanstalk에 배포하기

[Git] Git Submodule 사용 방법

[Go] gin 중첩 구조체 validation

[Go] gin validator 에러 메시지 변경