개요
예전에 jupyterlab / jupyter notebook을 사용할 때, 데이터베이스를 다루는 경우 jupyterlab-sql이라는 플러그인을 아주 잘 사용했다. 하지만 이 플러그인은 이제 유지보수가 이뤄지고 있지 않아 최신 버전의 jupyterlab에서는 사용이 불가능한 상태이다. 그래서 jupysql을 계속 사용해 왔는데, 최근 jupyterlab-sql을 대체할 만한 플러그인을 확인하여 기록해 둔다.
jupyterlab-sql-explorer
jupyterlab-sql-explorer는 사용자가 JupyterLab에서 SQL을 실행하고 데이터베이스 객체를 탐색할 수 있도록 도와주는 플러그인이다.
JupyterLab 내에서 테이블, 뷰와 같은 데이터베이스 객체를 탐색할 수 있고, SQL문을 직접 실행하고 반환된 결과를 확인할 수 있다. 또한 MySQL, PostgreSQL, Hive, SQLite, ORACLE 등 다양한 데이터베이스를 지원한다.
설치
설치는 pip를 통해서 할 수 있다.
pip install jupyterlab-sql-explorer
또는 JupyterLab의 pypi 관리자를 통해 설치할 수 있다.
설치 후 jupyterlab을 재시작하면 왼쪽 메뉴에 데이터베이스 모양 버튼이 노출된다.
데이터베이스 연결
새 데이터베이스 연결은 메뉴의 Add new database connection 버튼을 클릭하여 수행한다.
버튼을 클릭하면 연결할 데이터베이스 정보를 입력하는 폼이 나온다.
Name은 연결의 이름, 그리고 ID는 연결을 식별하는 값에 해당하는 것 같다. 이 외에는 연결한 데이터베이스의 엔진, 서버 주소, 포트 등의 정보를 지정한다.
이후 Summit을 클릭하면,
연결이 생성된 것을 확인할 수 있다.
사용법
연결을 더블클릭하면 데이터베이스를 확인할 수 있다.
마찬가지로 사용할 데이터베이스를 더블클릭하면 테이블 목록을 확인할 수 있다.
만약 SQL을 수행하고 싶다면, 마우스 우클릭 > Open Sql Console을 클릭하여 SQL 콘솔 창을 사용하면 된다.
참고 문서
https://github.com/groupnotes/jupyterlab-sql-explorer