Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mariadb: add page #15771

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

TreeOfJuly
Copy link

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Feb 22, 2025
Added a '.' at the end of 'More information...' to go along with proper syntax.
Updated it for the second time due to improper syntax.
@tldr-bot
Copy link

The build for this PR failed with the following error(s):

pages/common/mariadb.md:10: TLDR104 Example descriptions should prefer infinitive tense (e.g. write) over present (e.g. writes) or gerund (e.g. writing)

Please fix the error(s) and push again.

Improper syntax, ran tldr-lint and received no errors. Therefore, the file should not be fixed. Apologies for the repeated attempts.

`mariadb {{db_name}}`

- Connect to a specific MariaDB database {{db_name}} using {{user_name}} and {{your_password}}:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Connect to a specific MariaDB database {{db_name}} using {{user_name}} and {{your_password}}:
- Connect to a specific MariaDB database using username and password:

Copy link
Member

@CleanMachine1 CleanMachine1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!


`mariadb --user={{user_name}} --password={{your_password}} {{db_name}}`

- Display help and exit:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Display help and exit:
- Display help:


- Display help and exit:

`mariadb -?, --help`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`mariadb -?, --help`
`mariadb --help`


- Be more silent. Can be used multiple times to produce less output:

`mariadb -s, --silent`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`mariadb -s, --silent`
`mariadb {{-s,-ss,-sss}}`

Please fix this accordingly, I'm unsure if its correct, but based on most commands, 3 s is probably the max.


`mariadb --show-warning`

- Be more silent. Can be used multiple times to produce less output:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Be more silent. Can be used multiple times to produce less output:
- Display less verbose outputs:


- Execute SQL statements in a script file (batch file):

`mariadb {{db_name}} < {{/path/to/script.sql}} > {{/path/to/output.tab}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`mariadb {{db_name}} < {{/path/to/script.sql}} > {{/path/to/output.tab}}`
`mariadb {{db_name}} < {{path/to/script.sql}} > {{path/to/output.tab}}`

We use relative paths when available.


`mariadb -s, --silent`

- Execute SQL statements in a script file (batch file):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Execute SQL statements in a script file (batch file):
- Execute SQL statements from a script file:


- For connections to local host , Unix socket file to use, or on Windows, the name of the named pipe to use:

`mariadb -S, --socket={{/path/to/socket_name}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`mariadb -S, --socket={{/path/to/socket_name}}`
`mariadb -S, --socket={{path/to/socket_name}}`


`mariadb --debug-check`

- For connections to local host , Unix socket file to use, or on Windows, the name of the named pipe to use:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- For connections to local host , Unix socket file to use, or on Windows, the name of the named pipe to use:
- Connect using a socket file for local connections:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants