kallithea Changeset - 307c876a6e89

Changeset - 307c876a6e89

Parent rev.

Child rev.

[Not reviewed]

default

0 3 0

Mads Kiilerich (mads) - 6 years ago 2020-06-25 01:51:18
mads@kiilerich.com

db: introduce db-create --reuse option

Support use of an existing database so the Kallithea database user doesn't have
to be granted permissions to create databases.

The existing database must of course have been created "correctly", for example
using the right charset and collation on MariaDB/MySQL. Creating the database
manually also provides a way to avoid the hardcoded defaults.

3 files changed with 25 insertions and 6 deletions:

docs/setup.rst

kallithea/bin/kallithea_cli_db.py

kallithea/lib/db_manage.py

0 comments (0 inline, 0 general)

docs/setup.rst

➞

Show inline comments

@@ @@ -75,24 +75,33 @@ The ``db-create`` values can also be giv @@
 Example::
     kallithea-cli db-create -c my.ini --user=nn --password=secret --email=nn@example.com --repos=/srv/repos
 The ``db-create`` command will create all needed tables and an
 admin account. When choosing a root path you can either use a new
 empty location, or a location which already contains existing
 repositories. If you choose a location which contains existing
 repositories Kallithea will add all of the repositories at the chosen
 location to its database.  (Note: make sure you specify the correct
 path to the root).
 .. note:: It is also possible to use an existing database. For example,
           when using PostgreSQL without granting general createdb privileges to
           the PostgreSQL kallithea user, set ``sqlalchemy.url =
           postgresql://kallithea:password@localhost/kallithea`` and create the
           database like::
               sudo -u postgres createdb 'kallithea' --owner 'kallithea'
               kallithea-cli db-create -c my.ini --reuse
 Prepare front-end files
 ^^^^^^^^^^^^^^^^^^^^^^^
 Finally, the front-end files must be prepared. This requires ``npm`` version 6
 or later, which needs ``node.js`` (version 12 or later). Prepare the front-end
 by running::
     kallithea-cli front-end-build
 Running
 ^^^^^^^

kallithea/bin/kallithea_cli_db.py

➞

Show inline comments

@@ @@ -11,33 +11,35 @@ @@
+#
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 import click
 import kallithea
 import kallithea.bin.kallithea_cli_base as cli_base
 from kallithea.lib.db_manage import DbManage
 from kallithea.model.meta import Session
 @cli_base.register_command(config_file=True)
 @click.option('--reuse/--no-reuse', default=False,
         help='Reuse and clean existing database instead of dropping and creating (default: no reuse)')
 @click.option('--user', help='Username of administrator account.')
 @click.option('--password', help='Password for administrator account.')
 @click.option('--email', help='Email address of administrator account.')
 @click.option('--repos', help='Absolute path to repositories location.')
 @click.option('--force-yes', is_flag=True, help='Answer yes to every question.')
 @click.option('--force-no', is_flag=True, help='Answer no to every question.')
 @click.option('--public-access/--no-public-access', default=True,
         help='Enable/disable public access on this installation (default: enable)')
 def db_create(user, password, email, repos, force_yes, force_no, public_access):
+def db_create(user, password, email, repos, force_yes, force_no, public_access, reuse):
     """Initialize the database.
     Create all required tables in the database specified in the configuration
     file. Create the administrator account. Set certain settings based on
     values you provide.
     You can pass the answers to all questions as options to this command.
     """
     dbconf = kallithea.CONFIG['sqlalchemy.url']
     # force_ask should be True (yes), False (no), or None (ask)
     if force_yes:
@@ @@ -48,25 +50,25 @@ def db_create(user, password, email, rep @@
         force_ask = None
     cli_args = dict(
             username=user,
             password=password,
             email=email,
             repos_location=repos,
             force_ask=force_ask,
             public_access=public_access,
+    )
     dbmanage = DbManage(dbconf=dbconf, root=kallithea.CONFIG['here'],
                         tests=False, cli_args=cli_args)
     dbmanage.create_tables()
+    dbmanage.create_tables(reuse_database=reuse)
     repo_root_path = dbmanage.prompt_repo_root_path(None)
     dbmanage.create_settings(repo_root_path)
     dbmanage.create_default_user()
     dbmanage.admin_prompt()
     dbmanage.create_permissions()
     dbmanage.populate_default_permissions()
     Session().commit()
     # initial repository scan
     kallithea.config.application.make_app(
             kallithea.CONFIG.global_conf, **kallithea.CONFIG.local_conf)
     added, _ = kallithea.lib.utils.repo2db_mapper(kallithea.model.scm.ScmModel().repo_scan())

kallithea/lib/db_manage.py

➞

Show inline comments

@@ @@ -63,38 +63,46 @@ class DbManage(object): @@
         from kallithea.lib.utils2 import ask_ok
         return ask_ok(msg)
     def init_db(self, SESSION=None):
         if SESSION:
             self.sa = SESSION
         else:
             # init new sessions
             engine = create_engine(self.dburi)
             init_model(engine)
             self.sa = Session()
     def create_tables(self):
+    def create_tables(self, reuse_database=False):
         """
         Create database (optional) and tables.
         The database will be dropped (if it exists) and a new one created.
         If reuse_database is false, the database will be dropped (if it exists)
         and a new one created. If true, the existing database will be reused
         and cleaned for content.
         """
         url = sqlalchemy.engine.url.make_url(self.dburi)
         database = url.database
         log.info("The existing database %r will be destroyed and created." % database)
         if reuse_database:
             log.info("The content of the database %r will be destroyed and new tables created." % database)
         else:
             log.info("The existing database %r will be destroyed and a new one created." % database)
         if not self.tests:
             if not self._ask_ok('Are you sure to destroy old database? [y/n]'):
                 print('Nothing done.')
                 sys.exit(0)
         if True:
         if reuse_database:
             Base.metadata.drop_all()
         else:
             if url.drivername == 'mysql':
                 url.database = None  # don't connect to the database (it might not exist)
                 engine = sqlalchemy.create_engine(url)
                 with engine.connect() as conn:
                     conn.execute('DROP DATABASE IF EXISTS `%s`' % database)
                     conn.execute('CREATE DATABASE `%s` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci' % database)
             elif url.drivername == 'postgresql':
                 from psycopg2.extensions import ISOLATION_LEVEL_AUTOCOMMIT
                 url.database = 'postgres'  # connect to the system database (as the real one might not exist)
                 engine = sqlalchemy.create_engine(url)
                 with engine.connect() as conn:
                     conn.connection.set_isolation_level(ISOLATION_LEVEL_AUTOCOMMIT)

0 comments (0 inline, 0 general)