Skip to content

Commit 04075ac

Browse files
author
Roberto Garcia
committed
Updated XDevAPI documentation project.
Updated the namespaces filters for XDevAPI documentation project.
1 parent 2ac98be commit 04075ac

File tree

4 files changed

+200
-184
lines changed

4 files changed

+200
-184
lines changed

‎Documentation/DevGuide.shfbproj‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,15 @@
1818
<OutputPath>.\Output\</OutputPath>
1919
<HtmlHelpName>ConnectorNET</HtmlHelpName>
2020
<ApiFilter>
21-
<Filter entryType="Namespace" fullName="MySql.Data.MySqlClient" isExposed="True">
22-
<Filter entryType="Class" fullName="MySql.Data.MySqlClient.CustomInstaller" filterName="CustomInstaller" isExposed="False" />
23-
</Filter>
24-
<Filter entryType="Namespace" fullName="MySql.Web.Security" isExposed="True">
25-
<Filter entryType="Class" fullName="MySql.Web.Security.CustomInstaller" filterName="CustomInstaller" isExposed="False" />
26-
</Filter>
21+
<Filter entryType="Namespace" fullName="MySql.Data.Common" isExposed="False" />
22+
<Filter entryType="Namespace" fullName="MySql.Data.MySqlClient" isExposed="False" />
23+
<Filter entryType="Namespace" fullName="MySql.Data.MySqlClient.Authentication" isExposed="False" />
24+
<Filter entryType="Namespace" fullName="MySql.Data.MySqlClient.Memcached" isExposed="False" />
25+
<Filter entryType="Namespace" fullName="MySql.Data.MySqlClient.Replication" isExposed="False" />
26+
<Filter entryType="Namespace" fullName="MySql.Data.MySqlClient.X.XDevAPI.Common" isExposed="False" />
27+
<Filter entryType="Namespace" fullName="MySql.Data.Types" isExposed="False" />
28+
<Filter entryType="Namespace" fullName="MySqlX.Protocol" isExposed="False" />
29+
<Filter entryType="Namespace" fullName="MySqlX.Session" isExposed="False" />
2730
</ApiFilter>
2831
<ProjectSummary>
2932
</ProjectSummary>
@@ -44,13 +47,13 @@
4447
<RootNamespaceTitle>Reference</RootNamespaceTitle>
4548
<HelpTitle>MySQL Connector/Net</HelpTitle>
4649
<CopyrightHref>http://www.mysql.com</CopyrightHref>
47-
<CopyrightText>Copyright &amp;#169%3b 2004,2016 Oracle and/or its affiliates. All rights reserved.</CopyrightText>
50+
<CopyrightText>Copyright &amp;#169%3b 2004, 2017, Oracle and/or its affiliates. All rights reserved.</CopyrightText>
4851
<FeedbackEMailAddress>support%40oracle.com</FeedbackEMailAddress>
4952
<PresentationStyle>VS2013</PresentationStyle>
5053
<NamingMethod>MemberName</NamingMethod>
5154
<DocumentationSources>
52-
<DocumentationSource sourceFile="..\Source\MySql.Data\bin\v4.5.1\Release\MySql.Data.dll" />
53-
<DocumentationSource sourceFile="..\Source\MySql.Data\bin\v4.5.1\Release\MySql.Data.xml" />
55+
<DocumentationSource sourceFile="..\Source\MySql.Data\bin\Release\net451\MySql.Data.dll" />
56+
<DocumentationSource sourceFile="..\Source\MySql.Data\bin\Release\net451\MySql.Data.xml" />
5457
</DocumentationSources>
5558
<NamespaceSummaries>
5659
<NamespaceSummaryItem name="(global)" isDocumented="False" xmlns="" />
@@ -70,7 +73,7 @@
7073
</PlugInConfigurations>
7174
<VendorName>Oracle</VendorName>
7275
<HelpFileVersion>1.0.0.0</HelpFileVersion>
73-
<MaximumGroupParts>2</MaximumGroupParts>
76+
<MaximumGroupParts>10</MaximumGroupParts>
7477
<NamespaceGrouping>True</NamespaceGrouping>
7578
<SyntaxFilters>Standard</SyntaxFilters>
7679
<SdkLinkTarget>Blank</SdkLinkTarget>

‎Documentation/Layout.content‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<Topics>
3-
<Topic id="connector-net-x-devapi-reference" visible="True" isDefault="true" isExpanded="true" title="MySQL Connector/Net X DevAPI Reference">
3+
<Topic id="connector-net-x-devapi-reference" visible="True" isDefault="true" isExpanded="true" isSelected="true" title="MySQL Connector/Net X DevAPI Reference">
44
<Topic id="connector-net-x-devapi-installation" visible="True" title="Installation" />
5-
<Topic id="connector-net-x-devapi-getting-started" visible="True" title="Getting started guide" />
5+
<Topic id="connector-net-x-devapi-getting-started" visible="True" apiParentMode="InsertAfter" title="Getting started guide" />
66
</Topic>
77
</Topics>

‎Documentation/Users Guide/GettingStartedGuide.aml‎

Lines changed: 75 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,86 @@
11
<topic id="connector-net-x-devapi-getting-started" revisionNumber="1">
22
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
3-
<section address="connector-net">
3+
<section address="connector-net">
44
<content>
55
<autoOutline />
6-
<title>Introduction</title>
7-
<para>The MySQL Connector/Net 7.0.2 (or higher) getting started tutorial, provides an introduction to the X DevAPI functionality introduced with MySQL 5.7.12. X functionality includes the new X DevAPI (DevAPI), which offers a modern, integrative way to work with relational and document data without requiring SQL knowledge when developing .NET Framework applications.</para>
6+
<title>Introduction</title>
7+
<para>The MySQL Connector/Net 7.0.2 (or higher) getting started tutorial, provides an introduction to the X DevAPI functionality introduced with MySQL 5.7.12. X functionality includes the new X DevAPI (DevAPI), which offers a modern, integrative way to work with relational and document data without requiring SQL knowledge when developing .NET Framework applications.</para>
88

9-
<para>Requirements</para>
10-
<list class="bullet">
11-
<listItem>
12-
<para>Connector/Net 7.0.2 or later</para>
13-
</listItem>
14-
<listItem>
15-
<para>Visual Studio 2013/2015 Community Edition</para>
16-
</listItem>
17-
<listItem>
18-
<para>MySQL 5.7.12 or later</para>
19-
</listItem>
20-
</list>
21-
<para>Download Sample Database</para>
9+
<para>Requirements</para>
10+
<list class="bullet">
11+
<listItem>
12+
<para>Connector/Net 7.0.2 or later</para>
13+
</listItem>
14+
<listItem>
15+
<para>Visual Studio 2013/2015 Community Edition</para>
16+
</listItem>
17+
<listItem>
18+
<para>MySQL 5.7.12 or later</para>
19+
</listItem>
20+
</list>
21+
<para>Download Sample Database</para>
2222

23-
<para>A MySQL script is provided with data and a JSON collection.</para>
23+
<para>A MySQL script is provided with data and a JSON collection.</para>
2424

25-
<para>To install the world_x database sample, follow these steps:</para>
26-
<list class="bullet">
27-
<listItem>
28-
<para>Download world_x.zip from http://dev.mysql.com/doc/index-other.html</para>
29-
</listItem>
30-
<listItem>
31-
<para>Extract the installation archive to a temporary location such as /tmp/.</para>
32-
</listItem>
33-
<listItem>
34-
<para>Unpacking the archive results in two files, one of them named world_x.sql.</para>
35-
</listItem>
36-
<listItem>
37-
<para>Connect to the MySQL server using the mysql command-line client with the following command:</para>
38-
<para>shell> mysql -u root -p</para>
39-
<para>Enter your password when prompted. A non-root account can be used as long as the account has privileges to create new databases.</para>
40-
</listItem>
41-
<listItem>
42-
<para>Execute the world_x.sql script to create the database structure, and insert the data, by using the following command:</para>
43-
<para>mysql> SOURCE /temp/world_x.sql;</para>
44-
<para>Replace /temp/ with the path to the world_x.sql file on your system.</para>
45-
</listItem>
46-
47-
<para>The database contains the following:</para>
48-
<listItem>
49-
<para>Tables</para>
50-
<para>City: Information about some of the cities in those countries.</para>
51-
<para>Country: Minimal information about countries of the world.</para>
52-
<para>CountryLanguage: Languages spoken in each country.</para>
53-
</listItem>
54-
<listItem>
55-
<para>Collections:</para>
56-
<para>CountryInfo: Information about countries in the world.</para>
57-
</listItem>
58-
</list>
59-
<para>Getting started with MySQL Connector/Net 7.0.2 (or later)</para>
60-
<para>Creating an XSession</para>
61-
<para>
62-
An XSession is a high-level database session concept that is different from working with traditional low-level MySQL connections. It is important to understand that an XSession is not the same as a traditional MySQL Session. XSessions encapsulate one or more actual MySQL connections.</para>
63-
<para>- Create a new Visual Studio Console Project targeting .NET framework 4.5 or later.</para>
64-
<para>- Use C# or Visual Basic as your preference. This tutorial will be done using C#.</para>
65-
<para>- Add a reference in your project to the MySql.Data.dll 7.0.2</para>
66-
<para>- Add a reference to the Google.ProtocolBuffers.dll 2.4.1.555</para>
67-
<para>The following lines open the session so later on, a schema can be grabbed to make some basic operations.</para>
25+
<para>To install the world_x database sample, follow these steps:</para>
26+
<list class="bullet">
27+
<listItem>
28+
<para>Download world_x.zip from http://dev.mysql.com/doc/index-other.html</para>
29+
</listItem>
30+
<listItem>
31+
<para>Extract the installation archive to a temporary location such as /tmp/.</para>
32+
</listItem>
33+
<listItem>
34+
<para>Unpacking the archive results in two files, one of them named world_x.sql.</para>
35+
</listItem>
36+
<listItem>
37+
<para>Connect to the MySQL server using the mysql command-line client with the following command:</para>
38+
<para>shell> mysql -u root -p</para>
39+
<para>Enter your password when prompted. A non-root account can be used as long as the account has privileges to create new databases.</para>
40+
</listItem>
41+
<listItem>
42+
<para>Execute the world_x.sql script to create the database structure, and insert the data, by using the following command:</para>
43+
<para>mysql> SOURCE /temp/world_x.sql;</para>
44+
<para>Replace /temp/ with the path to the world_x.sql file on your system.</para>
45+
</listItem>
46+
<listItem>
47+
<para>The database contains the following:</para>
48+
</listItem>
49+
<listItem>
50+
<para>Tables</para>
51+
<para>City: Information about some of the cities in those countries.</para>
52+
<para>Country: Minimal information about countries of the world.</para>
53+
<para>CountryLanguage: Languages spoken in each country.</para>
54+
</listItem>
55+
<listItem>
56+
<para>Collections:</para>
57+
<para>CountryInfo: Information about countries in the world.</para>
58+
</listItem>
59+
</list>
60+
<para>Getting started with MySQL Connector/Net 7.0.2 (or later)</para>
61+
<para>Creating an XSession</para>
62+
<para>
63+
An XSession is a high-level database session concept that is different from working with traditional low-level MySQL connections. It is important to understand that an XSession is not the same as a traditional MySQL Session. XSessions encapsulate one or more actual MySQL connections.
64+
</para>
65+
<para>- Create a new Visual Studio Console Project targeting .NET framework 4.5.1 or later.</para>
66+
<para>- Use C# or Visual Basic as your preference. This tutorial will be done using C#.</para>
67+
<para>- Add a reference in your project to the MySql.Data.dll 7.0.X</para>
68+
<para>- Add a reference to Google.Protobuf 3.0.0</para>
69+
<para>The following lines open the session so later on, a schema can be grabbed to make some basic operations.</para>
6870
<codeReference>ClassDefinition#Define</codeReference>
69-
<para>- Finding a row inside a Collection</para>
70-
<para>Once the session is instantiated a find can be executed. The example uses the previous session object created:</para>
71-
<codeReference>ClassDefinition1#Define</codeReference>
72-
<para>- Insert a new document in a collection</para>
73-
<codeReference>ClassDefinition2#Define</codeReference>
74-
<para>- How to delete an specific document</para>
75-
<codeReference>ClassDefinition3#Define</codeReference>
76-
<para>- Closing the session</para>
77-
<codeReference>ClassDefinition4#Define</codeReference>
78-
<para>These are some very basic operations that can be done with a collection which overview about what can be achieved with this new DEV API.</para>
79-
<para>Here is the complete code example:</para>
80-
<codeReference>ClassDefinition5#Define</codeReference>
81-
</content>
71+
<para>- Finding a row inside a Collection</para>
72+
<para>Once the session is instantiated a find can be executed. The example uses the previous session object created:</para>
73+
<codeReference>ClassDefinition1#Define</codeReference>
74+
<para>- Insert a new document in a collection</para>
75+
<codeReference>ClassDefinition2#Define</codeReference>
76+
<para>- How to delete an specific document</para>
77+
<codeReference>ClassDefinition3#Define</codeReference>
78+
<para>- Closing the session</para>
79+
<codeReference>ClassDefinition4#Define</codeReference>
80+
<para>These are some very basic operations that can be done with a collection which overview about what can be achieved with this new DEV API.</para>
81+
<para>Here is the complete code example:</para>
82+
<codeReference>ClassDefinition5#Define</codeReference>
83+
</content>
8284
</section>
8385
</developerConceptualDocument>
8486
</topic>

0 commit comments

Comments
 (0)