Embeddable을 ClickHouse에 연결하기

Embeddable은 빠르고 인터랙티브하며 완전히 맞춤화된 분석 환경을 앱에 직접 구축할 수 있도록 지원하는 개발자용 툴킷입니다.

Embeddable에서는 코드(자체 코드 리포지토리에 저장됨)로 데이터 모델과 컴포넌트를 정의하고, SDK를 사용해 이를 강력한 Embeddable 노코드 빌더에서 팀이 활용할 수 있게 합니다.

그 결과, 제품에 빠르고 인터랙티브한 고객 대상 분석 기능을 직접 제공할 수 있습니다. 제품 팀이 설계하고, 엔지니어링 팀이 구축하며, 고객 접점 팀과 데이터 팀이 유지 관리합니다. 마땅히 그래야 하는 방식입니다.

기본 제공되는 행 수준 보안(row-level security)을 통해 모든 사용자는 자신에게 허용된 데이터만 볼 수 있습니다. 또한 완전히 구성 가능한 두 단계의 캐싱을 통해 대규모 환경에서도 빠른 실시간 분석을 제공할 수 있습니다.

​

1. 연결 정보를 준비하세요

HTTP(S)로 ClickHouse에 연결하려면 다음 정보가 필요합니다.

매개변수	설명
HOST and PORT	일반적으로 TLS를 사용하는 경우 포트는 8443, TLS를 사용하지 않는 경우 8123입니다.
DATABASE NAME	기본적으로 default라는 이름의 데이터베이스가 제공되며, 연결할 데이터베이스 이름을 사용하십시오.
USERNAME and PASSWORD	기본 사용자 이름은 default입니다. 사용 사례에 맞는 사용자 이름을 사용하십시오.

ClickHouse Cloud 서비스의 연결 정보는 ClickHouse Cloud 콘솔에서 확인할 수 있습니다. 서비스를 선택한 다음 Connect를 클릭하십시오.

HTTPS를 선택하십시오. 연결 정보가 예시 curl 명령으로 표시됩니다.

자가 관리형 ClickHouse를 사용하는 경우 연결 정보는 ClickHouse 관리자가 설정합니다.

​

2. ClickHouse 연결 유형 생성

Embeddable API를 사용해 데이터베이스 연결을 추가합니다. 이 연결은 ClickHouse 서비스에 접속하는 데 사용됩니다. 다음 API 호출로 연결을 추가할 수 있습니다.

Query

// 보안상의 이유로, 이 코드는 클라이언트 측에서 *절대* 호출해서는 안 됩니다
fetch('https://api.embeddable.com/api/v1/connections', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Accept: 'application/json',
    Authorization: `Bearer ${apiKey}` /* API Key를 안전하게 보관하십시오 */,
  },
  body: JSON.stringify({
    name: 'my-clickhouse-db',
    type: 'clickhouse',
    credentials: {
      host: 'my.clickhouse.host',
      user: 'clickhouse_user',
      port: 8443,
      password: '*****',
    },
  }),
});

Response

Status 201 { errorMessage: null }

위 내용은 CREATE 작업을 나타내지만, 모든 CRUD 작업을 사용할 수 있습니다.

apiKey는 Embeddable 대시보드 중 하나에서 “Publish”를 클릭하면 확인할 수 있습니다.

name은 이 연결을 식별하는 고유한 이름입니다.

• 기본적으로 데이터 모델은 “default”라는 연결을 찾습니다. 하지만 서로 다른 데이터 모델을 서로 다른 연결에 연결할 수 있도록 모델에 다른 data_source 이름을 지정할 수 있습니다(모델에서 data_source 이름만 지정하면 됩니다).

type은 Embeddable에서 어떤 드라이버를 사용할지 지정합니다

• 여기서는 clickhouse를 사용하면 되지만, 하나의 Embeddable 워크스페이스에 여러 데이터 소스를 연결할 수 있으므로 postgres, bigquery, mongodb 등 다른 유형도 사용할 수 있습니다.

credentials는 드라이버에 필요한 자격 증명을 포함하는 JavaScript 객체입니다

• 이 정보는 안전하게 암호화되며, 데이터 모델에 정의한 데이터를 정확히 가져오는 데만 사용됩니다. Embeddable은 각 연결마다 읽기 전용 데이터베이스 사용자를 생성할 것을 강력히 권장합니다(Embeddable은 데이터베이스에서 읽기만 하며, 쓰기는 하지 않습니다).

prod, qa, test 등 여러 환경의 서로 다른 데이터베이스에 연결해야 하거나(또는 고객별로 서로 다른 데이터베이스를 지원해야 하는 경우), 각 연결을 환경에 할당할 수 있습니다(Environments API 참조).