IntenseWebs/discourse
3
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2024-11-22 17:06:31 -06:00
Code Issues Packages Projects Releases Wiki Activity

regex remapping: update usage and add help description.

Browse Source 
Here is a shell session showing what the new documenation looks like:

vagrant@discourse:~/vagrant$ bundle exec ruby ./script/discourse remap
ERROR: "discourse remap" was called with no arguments
Usage: "discourse remap [--global,--regex] FROM TO"

vagrant@discourse:~/vagrant$ bundle exec ruby ./script/discourse help remap
Usage:
  discourse remap [--global,--regex] FROM TO

Options:
      [--global], [--no-global]
      [--regex], [--no-regex]
  v, [--verbose=VERBOSE]

Description:
  Replace a string sequence FROM with TO across all tables.

  With --global option, the remapping is run on ***ALL*** databases. Instead of just running on the current database, run on every database on this machine. This option is useful for multi-site setups.

  With --regex option, use PostgreSQL function regexp_replace to do the remapping. Enabling this interprets FROM as a PostgreSQL regular expression. TO can contain references to captures in the FROM match. See the "Regular Expression
  Details" section and "regexp_replace" documentation in the PostgreSQL manual for more details.

  Examples:

  discourse remap talk.foo.com talk.bar.com # renaming a Discourse domain name

  discourse remap --regex "[/?color(=[^]]*)*]" "" # removing "color" bbcodes
This commit is contained in:
Ryan Mulligan 2017-01-30 14:27:45 -08:00
parent e63faffdb2
commit 6c2f66124f
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
script/discourse
View File

@ -5,7 +5,29 @@ require "thor"
class DiscourseCLI < Thor
class_option :verbose, default: false, aliases: :v
desc "remap", "Remap a string sequence accross all tables"
desc "remap [--global,--regex] FROM TO", "Remap a string sequence accross all tables"
long_desc <<-LONGDESC
Replace a string sequence FROM with TO across all tables.
With --global option, the remapping is run on ***ALL***
databases. Instead of just running on the current database, run on
every database on this machine. This option is useful for
multi-site setups.
With --regex option, use PostgreSQL function regexp_replace to do
the remapping. Enabling this interprets FROM as a PostgreSQL
regular expression. TO can contain references to captures in the
FROM match. See the "Regular Expression Details" section and
"regexp_replace" documentation in the PostgreSQL manual for more
details.
Examples:
discourse remap talk.foo.com talk.bar.com # renaming a Discourse domain name
discourse remap --regex "\[\/?color(=[^\]]*)*]" "" # removing "color" bbcodes
LONGDESC
option :global, :type => :boolean
option :regex, :type => :boolean
def remap(from, to)