Skip to content

Commit 90fed10

Browse files
patrickbirchpatrickbirch
committed
PS-9653 [DOCS] - Add audit_log_filter set_filter examples 8.4
 modified: docs/filter-audit-log-filter-files.md
1 parent 08140c6 commit 90fed10

4 files changed

+616
-6
lines changed

‎docs/filter-audit-log-filter-files.md

+140-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,144 @@ The default account is represented by `%` as the account name.
4343

4444
You can assign filters to a specific user account or disassociate a user account from a filter. To disassociate a user account, either unassign a filter or assign a different filter. If you remove a filter, that filter is unassigned from all users, including current users in current sessions.
4545

46-
47-
48-
46+
## set_filter options and available filters
47+
48+
| Filter | Available options |
49+
|------------------|-----------------------------------------------------------------------------------|
50+
| class Filter | `general`: Logs general server events |
51+
| | `connection`: Tracks connection-related activities |
52+
| | `table_access`: Monitors database table interactions |
53+
| user Filter | Accepts specific usernames as filter criteria |
54+
| | Can include multiple usernames |
55+
| | Supports wildcard matching |
56+
| database Filter | Filters events by database name |
57+
| | Accepts exact database names |
58+
| | Supports wildcard matching for database selection |
59+
| table Filter | Specifies individual table names |
60+
| | Allows filtering for specific tables within databases |
61+
| | Supports wildcard matching |
62+
| operation Filter | `read`: SELECT statements |
63+
| | `write`: INSERT, UPDATE, DELETE statements |
64+
| | `ddl`: Data Definition Language operations |
65+
| | `dcl`: Data Control Language operations |
66+
| event Filter | `status`: Tracks query execution status |
67+
| | `query`: Captures query details |
68+
| | `connection`: Monitors connection events |
69+
| status Filter | `0`: Successful operations |
70+
| | `1`: Failed operations |
71+
72+
### Examples
73+
74+
Create simple filters
75+
76+
```{.bash data-prompt="mysql>"}
77+
mysql> SELECT audit_log_filter_set_filter('log_general', '{
78+
"filter": {
79+
"class": {
80+
"name": "general"
81+
}
82+
}
83+
}');
84+
85+
mysql> SELECT audit_log_filter_set_filter('log_connection', '{
86+
"filter": {
87+
"class": {
88+
"name": "connection"
89+
}
90+
}
91+
}');
92+
93+
mysql> SELECT audit_log_filter_set_filter('log_table_access', '{
94+
"filter": {
95+
"class": {
96+
"name": "table_access"
97+
}
98+
}
99+
}');
100+
101+
mysql> SELECT audit_log_filter_set_filter('log_global_variable', '{
102+
"filter": {
103+
"class": {
104+
"name": "global_variable"
105+
}
106+
}
107+
}');
108+
109+
mysql> SELECT audit_log_filter_set_filter('log_command', '{
110+
"filter": {
111+
"class": {
112+
"name": "command"
113+
}
114+
}
115+
}');
116+
117+
mysql> SELECT audit_log_filter_set_filter('log_query', '{
118+
"filter": {
119+
"class": {
120+
"name": "query"
121+
}
122+
}
123+
}');
124+
125+
mysql> SELECT audit_log_filter_set_filter('log_stored_program', '{
126+
"filter": {
127+
"class": {
128+
"name": "stored_program"
129+
}
130+
}
131+
}');
132+
133+
mysql> SELECT audit_log_filter_set_filter('log_authentication', '{
134+
"filter": {
135+
"class": {
136+
"name": "authentication"
137+
}
138+
}
139+
}');
140+
141+
mysql> SELECT audit_log_filter_set_filter('log_message', '{
142+
"filter": {
143+
"class": {
144+
"name": "message"
145+
}
146+
}
147+
}');
148+
```
149+
150+
Add filter_update_on_user_change.
151+
152+
```{.bash data-prompt="mysql>"}
153+
mysql> SELECT audit_log_filter_set_filter('log_connect', '{
154+
"filter": {
155+
"class": {
156+
"name": "connection",
157+
"event": {
158+
"name": "connect"
159+
}
160+
}
161+
}
162+
}');
163+
164+
mysql> SELECT audit_log_filter_set_filter('log_disconnect', '{
165+
"filter": {
166+
"class": {
167+
"name": "connection",
168+
"event": {
169+
"name": "disconnect"
170+
}
171+
}
172+
}
173+
}');
174+
```
175+
176+
| Option | Filters | Example | Event |
177+
|-------------|---------------------------------------------|--------------------------------|-------------------------------------------|
178+
| class | general, connection, table_access | N/A | general: Server-wide events, query processing<br>connection: Login, logout, connection attempts<br>table_access: Database and table-level interactions |
179+
| user | Filters by MySQL user accounts | ["admin", "readonly_user"] | All actions performed by specified users |
180+
| database | Filters by database name | ["sales", "inventory"] | Operations within specified databases |
181+
| table | Filters by table name | ["customers", "orders"] | Interactions with specific tables |
182+
| operation | For table_access: read, insert, update, delete<br>For connection: connect, disconnect | N/A | Specific types of database operations |
183+
| status | 0: Successful queries<br>1: Failed queries | N/A | Query execution result filtering |
184+
| thread_id | Filters by specific MySQL thread identifiers | ["12345", "67890"] | Actions within a particular database thread |
185+
| query_time | Filters based on query execution duration | N/A | Long-running or quick queries |
49186

‎docs/json-overview.md

+64-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,67 @@
1-
# JSON in MySQL
1+
# JSON in Percona Server for MySQL
2+
3+
JSON stands for JavaScript Object Notation. It is a lightweight data-interchange format that is easy for humans to read and write. It is also easy for machines to parse and generate. Percona Server for MySQL supports JSON data type, allowing you to store JSON documents in your database.
4+
5+
The JSON data type in Percona Server for MySQL is a handy way to store and work with flexible, semi-structured data right in your database. Think of it as a way to save JSON objects directly into your tables, so you don’t have to convert them into a rigid format.
6+
7+
When you use the JSON data type, the database stores your data in a special binary format that’s optimized for speed and space which is faster and more efficient than just saving JSON as plain text.
8+
9+
The JSON data type is great when your data doesn’t fit into a fixed structure or if it’s likely to change over time. The following are examples of when you would use the JSON data type:
10+
11+
* Storing user preferences or settings.
12+
13+
* Capturing logs or other dynamic data.
14+
15+
* Handling complex objects without adding a ton of columns to your table.
16+
17+
JSON has the following features:
18+
19+
<style>
20+
table {
21+
width: 100%;
22+
border-collapse: collapse;
23+
}
24+
th, td {
25+
border: 1px solid #ccc;
26+
padding: 8px;
27+
text-align: left;
28+
}
29+
th:first-child, td:first-child {
30+
width: auto;
31+
white-space: nowrap;
32+
}
33+
</style>
34+
35+
| Feature | Details |
36+
|----------------------|-----------------------------------------------------------------------------------------------------------------------|
37+
| Validation Built-In | Percona Server checks your JSON data when you insert or update it to make sure it’s valid. If something’s wrong, you’ll know right away. |
38+
| Powerful Querying | You can dig into specific parts of your JSON data using built-in functions like the following: <br> - `JSON_EXTRACT()` to pull out specific keys or values. <br> - `JSON_CONTAINS()` to check if a key or value exists. <br> - `JSON_SET()` to update parts of your JSON object without replacing the whole thing. |
39+
| Indexing for Speed | If you often query a particular key inside your JSON, you can create a generated column based on that key and index it, making queries much faster. |
40+
41+
## Use JSON in your database
42+
43+
The following is an example using JSON in your database.
44+
45+
```JSON
46+
CREATE TABLE user_data (
47+
id INT PRIMARY KEY AUTO_INCREMENT,
48+
name VARCHAR(50),
49+
settings JSON
50+
);
51+
52+
INSERT INTO user_data (name, settings)
53+
VALUES ('John', '{"theme": "dark", "notifications": {"email": true, "sms": false}}');
54+
55+
SELECT JSON_EXTRACT(settings, '$.theme') AS theme
56+
FROM user_data
57+
WHERE name = 'John';
58+
```
59+
60+
* The settings column stores JSON data.
61+
62+
* You can use `JSON_EXTRACT()` to get the value of a specific key, like theme.
263

3-
JSON stands for JavaScript Object Notation. It is a lightweight data-interchange format that is easy for humans to read and write. It is also easy for machines to parse and generate. MySQL supports JSON data type, allowing you to store JSON documents in your database.
64+
JSON in Percona Server for MySQL gives you have the flexibility of NoSQL with the reliability and querying power of a relational database.
465

566
## Create a table with JSON Data Type
667

@@ -81,7 +142,7 @@ WHERE name = 'John Doe';
81142

82143
## Use JSON Functions
83144

84-
MySQL provides several functions to work with JSON data.
145+
Percona Server for MySQL provides several functions to work with JSON data.
85146

86147
### `JSON_EXTRACT`
87148

0 commit comments

Comments
 (0)